> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xenia.team/llms.txt
> Use this file to discover all available pages before exploring further.

# Pause or Resume Project

> Toggles the project's paused flag: a running project is paused, a paused project is resumed. There is no way to request a specific target state — read `isPaused` first if you need to be sure which way it will go. Pausing stops new tasks being generated from the project's schedules. Requires both `Pause/Resume Project` and `Manage Tasks` permissions.



## OpenAPI

````yaml GET /api/v1/ops/workspaces/{workspaceId}/projects/{projectId}/toggle-pause
openapi: 3.1.0
info:
  title: Xenia Team API - Pause or Resume Project
  version: 1.0.0
  description: >-
    Flips the project between paused and active. This is a GET that changes
    state — it is the one exception to GETs being read-only in this API.
servers:
  - url: https://api.xenia.team
security: []
paths:
  /api/v1/ops/workspaces/{workspaceId}/projects/{projectId}/toggle-pause:
    get:
      tags:
        - Projects
      summary: Pause or Resume Project
      description: >-
        Toggles the project's paused flag: a running project is paused, a paused
        project is resumed. There is no way to request a specific target state —
        read `isPaused` first if you need to be sure which way it will go.
        Pausing stops new tasks being generated from the project's schedules.
        Requires both `Pause/Resume Project` and `Manage Tasks` permissions.
      parameters:
        - name: workspaceId
          in: path
          required: true
          description: UUID of the workspace. Must be the workspace the API key belongs to.
          schema:
            type: string
            format: uuid
            example: cb363f7e-c52a-4478-911d-f6a6f791090e
        - name: projectId
          in: path
          required: true
          description: UUID of the project.
          schema:
            type: string
            format: uuid
            example: c7966d63-52ce-4967-b30a-16aaa9e806b5
      responses:
        '200':
          description: >-
            Project paused or resumed. The `extra_meta.message` states which
            happened.
          content:
            application/json:
              example:
                data:
                  id: c7966d63-52ce-4967-b30a-16aaa9e806b5
                  title: Monthly Safety Walk
                  isPaused: true
                  type: role
                  state: ready
                  entityIds:
                    - 7481ca15-cdb1-4e0f-a936-f8f88a56e989
                  isLocationAutoTag: true
                  isSchedulesProject: true
                  assigneesRoles:
                    creationType: role
                    roles:
                      - 7481ca15-cdb1-4e0f-a936-f8f88a56e989
                    locations: []
                    locationGroups: []
                  metadata: {}
                  createdAt: '2026-07-30T18:47:09.085Z'
                  updatedAt: '2026-07-30T18:47:09.085Z'
                extra_meta:
                  message: Project has been paused
        '400':
          description: >-
            Bad Request - `Project is under processing`. The project's `state`
            is not yet `ready`, so its schedules cannot be changed.
        '401':
          description: >-
            Unauthorized - Invalid client credentials, or the key does not
            belong to this workspace.
        '403':
          description: >-
            Forbidden - API key not authorized for this route, the role lacks
            the required permission, the workspace does not have the Projects
            feature, or the project id is unknown to the caller. Note an unknown
            or deleted projectId also returns 403, not 404: the project access
            check runs before the handler and denies when it cannot load the
            project.
        '500':
          description: Internal Server Error.
      security:
        - clientKey: []
          clientSecret: []
components:
  securitySchemes:
    clientKey:
      type: apiKey
      in: header
      name: x-client-key
    clientSecret:
      type: apiKey
      in: header
      name: x-client-secret

````