OpenProject Workspace API

openapi: 3.2.0
info:
  description: You're looking at the current **stable** documentation of the OpenProject APIv3.
  title: OpenProject API V3 (Stable) Workspace API
  version: '3'
servers:
- url: https://qa.openproject-edge.com
  description: Edge QA instance
- url: https://qa.openproject-stage.com
  description: Staging instance
- url: https://community.openproject.org
  description: Community instance
security:
- BasicAuth: []
tags:
- name: Workspace
paths:
  /api/v3/workspaces:
    get:
      summary: List workspace
      operationId: list_workspace
      tags:
      - Workspace
      description: 'Returns a collection of workspaces. The collection can be filtered via query parameters similar to how work packages are filtered. In addition to the provided filter, the result set is always limited to only contain workspaces the client is allowed to see.

        Since workspaces are the generic term for a number of resources like projects and portfolios, the returned collection will contain a mix of those resources.'
      parameters:
      - name: filters
        schema:
          type: string
        in: query
        required: false
        description: 'JSON specifying filter conditions.

          Accepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint.

          Currently supported filters are:


          + active: based on the active property of the workspace

          + ancestor: filters workspace by their ancestor. A workspace is not considered to be its own ancestor.

          + available_project_attributes: filters workspace based on the activated project attributes.

          + created_at: based on the time the workspace was created

          + favorited: based on the favorited property of the workspace

          + id: based on workspace'' id.

          + latest_activity_at: based on the time the last activity was registered on a workspace.

          + name_and_identifier: based on both the name and the identifier.

          + parent_id: filters workspace by their parent.

          + principal: based on members of the workspace.

          + project_phase_any: based on the project phases active in a workspace.

          + project_status_code: based on status code of the workspace

          + storage_id: filters workspace by linked storages

          + storage_url: filters workspace by linked storages identified by the host url

          + type_id: based on the types active in a workspace.

          + user_action: based on the actions the current user has in the workspace.

          + visible: based on the visibility for the user (id) provided as the filter value. This filter is useful for admins to identify the workspace visible to a user.


          There might also be additional filters based on the custom fields that have been configured.


          Each defined lifecycle step will also define a filter in this list endpoint. Given that the elements are not

          static but rather dynamically created on each OpenProject instance, a list cannot be provided. Those filters follow the schema:

          + project_start_gate_[id]: a filter on a project phase''s start gate active in a workspace. The id is the id of the phase the gate belongs to.

          + project_finish_gate_[id]: a filter on a project phase''s finish gate active in a workspace. The id is the id of the phase the gate belongs to.

          + project_phase_[id]: a filter on a project phase active in a workspace. The id is the id of the phase queried for.'
        example: '[{ "ancestor": { "operator": "=", "values": ["1"] }" }]'
      - name: sortBy
        schema:
          type: string
        in: query
        required: false
        description: 'JSON specifying sort criteria.

          Currently supported orders are:


          + id

          + name

          + typeahead (sorting by hierarchy and name)

          + created_at

          + public

          + latest_activity_at

          + required_disk_space


          There might also be additional orders based on the custom fields that have been configured.'
        example: '[["id", "asc"]]'
      - name: select
        schema:
          type: string
        in: query
        required: false
        description: Comma separated list of properties to include.
        example: total,elements/identifier,elements/name
      responses:
        '200':
          description: OK
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/WorkspaceCollectionModel'
        '400':
          description: Returned if the client sends invalid request parameters e.g. filters
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                _type: Error
                errorIdentifier: urn:openproject-org:api:v3:errors:InvalidQuery
                message: Filters Invalid filter does not exist.
components:
  schemas:
    WorkspaceCollectionModel:
      allOf:
      - $ref: '#/components/schemas/OffsetPaginatedCollectionModel'
      - type: object
        required:
        - _links
        - _embedded
        properties:
          _links:
            allOf:
            - $ref: '#/components/schemas/OffsetPaginatedCollectionLinks'
            - type: object
              properties:
                representations:
                  type: array
                  items:
                    allOf:
                    - $ref: '#/components/schemas/Link'
                    - description: A workspace collection representation in a specific file format.
          _embedded:
            type: object
            required:
            - elements
            properties:
              elements:
                type: array
                items:
                  oneOf:
                  - $ref: '#/components/schemas/PortfolioModel'
                  - $ref: '#/components/schemas/ProgramModel'
                  - $ref: '#/components/schemas/ProjectModel'
    CollectionLinks:
      type: object
      required:
      - self
      properties:
        self:
          allOf:
          - $ref: '#/components/schemas/Link'
          - description: 'This collection resource.


              **Resource**: Collection'
    CustomFieldProperties:
      type: object
      patternProperties:
        ^customField\d+$:
          type:
          - 'null'
          - number
          - boolean
          - string
          - object
          description: 'A custom field value, that belongs to a custom field of a simple type:


            - Boolean

            - Date

            - Float

            - Integer

            - Link (URL)

            - Text

            - Long text'
    ProjectModel:
      allOf:
      - $ref: '#/components/schemas/CustomFieldProperties'
      - $ref: '#/components/schemas/CustomCommentProperties'
      - type: object
        properties:
          _type:
            type: string
            enum:
            - Project
          id:
            type: integer
            description: Projects' id
            minimum: 1
          identifier:
            type: string
          name:
            type: string
          active:
            type: boolean
            description: Indicates whether the project is currently active or already archived
          favorited:
            type: boolean
            description: Indicates whether the project is favorited by the current user
          statusExplanation:
            allOf:
            - $ref: '#/components/schemas/Formattable'
            - description: A text detailing and explaining why the project has the reported status
          public:
            type: boolean
            description: Indicates whether the project is accessible for everybody
          description:
            $ref: '#/components/schemas/Formattable'
          createdAt:
            type: string
            format: date-time
            description: Time of creation. Can be writable by admins with the `apiv3_write_readonly_attributes` setting enabled.
          updatedAt:
            type: string
            format: date-time
            description: Time of the most recent change to the project
          _links:
            type: object
            required:
            - self
            - categories
            properties:
              update:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Form endpoint that aids in updating this project


                    # Conditions


                    **Permission**: edit workspace'
              updateImmediately:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Directly update this project


                    # Conditions


                    **Permission**: edit workspace'
              delete:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Delete this project


                    # Conditions


                    **Permission**: admin'
              favor:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Mark this project as favorited by the current user


                    # Conditions


                    Only present if the project is not yet favorited


                    Permission**: none but login is required'
              disfavor:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Mark this project as not favorited by the current user


                    # Conditions

                    Only present if the project is favorited by the current user


                    Permission**: none but login is required'
              createWorkPackage:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Form endpoint that aids in preparing and creating a work package


                    # Conditions


                    **Permission**: add work packages'
              createWorkPackageImmediately:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Directly creates a work package in the project


                    # Conditions


                    **Permission**: add work packages'
              self:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'This project


                    **Resource**: Project'
              categories:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Categories available in this project


                    **Resource**: Collection'
              types:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Types available in this project


                    **Resource**: Collection


                    # Conditions


                    **Permission**: view work packages or manage types'
              versions:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Versions available in this project


                    **Resource**: Collection


                    # Conditions


                    **Permission**: view work packages or manage versions'
              memberships:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Memberships in the project


                    **Resource**: Collection


                    # Conditions


                    **Permission**: view members'
              workPackages:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Work Packages of this project


                    **Resource**: Collection'
              parent:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Parent of the project


                    **Resource**: Workspace


                    # Conditions


                    **Permission** edit workspace'
              status:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Denotes the status of the project, so whether the project is on track, at risk or is having trouble.


                    **Resource**: ProjectStatus


                    # Conditions


                    **Permission** edit workspace'
              storages:
                type: array
                items:
                  allOf:
                  - $ref: '#/components/schemas/Link'
                  - description: 'The link to a storage that is active for this project.


                      **Resource**: Storage


                      # Conditions


                      **Permission**: view_file_links'
              projectStorages:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'The project storage collection of this project.


                    **Resource**: Collection


                    # Conditions


                    **Permission**: view_file_links'
              ancestors:
                type: array
                items:
                  allOf:
                  - $ref: '#/components/schemas/Link'
                  - description: 'A collection of links to the ancestor workspaces.


                      **Resource**: Workspace'
    Link:
      type: object
      required:
      - href
      properties:
        href:
          type:
          - string
          - 'null'
          description: URL to the referenced resource (might be relative)
        title:
          type: string
          description: Representative label for the resource
        templated:
          type: boolean
          default: false
          description: If true the href contains parts that need to be replaced by the client
        method:
          type: string
          default: GET
          description: The HTTP verb to use when requesting the resource
        payload:
          type: object
          description: The payload to send in the request to achieve the desired result
        identifier:
          type: string
          description: An optional unique identifier to the link object
        type:
          type: string
          description: The MIME-Type of the returned resource.
      example:
        href: /api/v3/work_packages
        method: POST
    Formattable:
      type: object
      required:
      - format
      properties:
        format:
          type: string
          enum:
          - plain
          - markdown
          - custom
          readOnly: true
          description: Indicates the formatting language of the raw text
          example: markdown
        raw:
          type: string
          description: The raw text, as entered by the user
          example: I **am** formatted!
        html:
          type: string
          readOnly: true
          description: The text converted to HTML according to the format
          example: I <strong>am</strong> formatted!
      example:
        format: markdown
        raw: I am formatted!
        html: I am formatted!
    OffsetPaginatedCollectionLinks:
      allOf:
      - $ref: '#/components/schemas/CollectionLinks'
      - type: object
        required:
        - jumpTo
        - changeSize
        properties:
          jumpTo:
            allOf:
            - $ref: '#/components/schemas/Link'
            - description: A templated link to jump to a given offset.
          changeSize:
            allOf:
            - $ref: '#/components/schemas/Link'
            - description: A templated link to change the current page size.
          previousByOffset:
            allOf:
            - $ref: '#/components/schemas/Link'
            - description: 'A link to the previous page of the collection.


                # Conditions

                - The collection is not on the first page.'
          nextByOffset:
            allOf:
            - $ref: '#/components/schemas/Link'
            - description: 'A link to the next page of the collection.


                # Conditions

                - The collection is not on the last page.'
    ProgramModel:
      allOf:
      - $ref: '#/components/schemas/CustomFieldProperties'
      - $ref: '#/components/schemas/CustomCommentProperties'
      - type: object
        properties:
          _type:
            type: string
            enum:
            - Program
          id:
            type: integer
            description: Programs' id
            minimum: 1
          identifier:
            type: string
          name:
            type: string
          active:
            type: boolean
            description: Indicates whether the program is currently active or already archived
          favorited:
            type: boolean
            description: Indicates whether the program is favorited by the current user
          statusExplanation:
            allOf:
            - $ref: '#/components/schemas/Formattable'
            - description: A text detailing and explaining why the program has the reported status
          public:
            type: boolean
            description: Indicates whether the program is accessible for everybody
          description:
            $ref: '#/components/schemas/Formattable'
          createdAt:
            type: string
            format: date-time
            description: Time of creation. Can be writable by admins with the `apiv3_write_readonly_attributes` setting enabled.
          updatedAt:
            type: string
            format: date-time
            description: Time of the most recent change to the program
          _links:
            type: object
            required:
            - self
            - categories
            properties:
              update:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Form endpoint that aids in updating this program


                    # Conditions


                    **Permission**: edit workspace'
              updateImmediately:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Directly update this program


                    # Conditions


                    **Permission**: edit workspace'
              delete:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Delete this program


                    # Conditions


                    **Permission**: admin'
              favor:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Mark this program as favorited by the current user


                    # Conditions


                    Only present if the program is not yet favorited


                    Permission**: none but login is required'
              disfavor:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Mark this program as not favorited by the current user


                    # Conditions

                    Only present if the program is favorited by the current user


                    Permission**: none but login is required'
              createWorkPackage:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Form endpoint that aids in preparing and creating a work package


                    # Conditions


                    **Permission**: add work packages'
              createWorkPackageImmediately:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Directly creates a work package in the program


                    # Conditions


                    **Permission**: add work packages'
              self:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'This program


                    **Resource**: Program'
              categories:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Categories available in this program


                    **Resource**: Collection'
              types:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Types available in this program


                    **Resource**: Collection


                    # Conditions


                    **Permission**: view work packages or manage types'
              versions:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Versions available in this program


                    **Resource**: Collection


                    # Conditions


                    **Permission**: view work packages or manage versions'
              memberships:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Memberships in the  program


                    **Resource**: Collection


                    # Conditions


                    **Permission**: view members'
              workPackages:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Work Packages of this program


                    **Resource**: Collection'
              parent:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Parent of the program


                    **Resource**: Program


                    # Conditions


                    **Permission** edit workspace'
              status:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Denotes the status of the program, so whether the program is on track, at risk or is having trouble.


                    **Resource**: ProjectStatus


                    # Conditions


                    **Permission** edit workspace'
              storages:
                type: array
                items:
                  allOf:
                  - $ref: '#/components/schemas/Link'
                  - description: 'The link to a storage that is active for this program.


                      **Resource**: Storage


                      # Conditions


                      **Permission**: view_file_links'
              projectStorages:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'The project storage collection of this program.


                    **Resource**: Collection


                    # Conditions


                    **Permission**: view_file_links'
              ancestors:
                type: array
                items:
                  allOf:
                  - $ref: '#/components/schemas/Link'
                  - description: 'A collection of links to the ancestor workspace.


                      **Resource**: Workspace'
    ErrorResponse:
      type: object
      required:
      - _type
      - errorIdentifier
      - message
      properties:
        _embedded:
          type: object
          properties:
            details:
              type: object
              properties:
                attribute:
                  type: string
                  example: project
        _type:
          type: string
          enum:
          - Error
        errorIdentifier:
          type: string
          example: urn:openproject-org:api:v3:errors:PropertyConstraintViolation
        message:
          type: string
          example: Project can't be blank.
    PortfolioModel:
      allOf:
      - $ref: '#/components/schemas/CustomFieldProperties'
      - $ref: '#/components/schemas/CustomCommentProperties'
      - type: object
        properties:
          _type:
            type: string
            enum:
            - Portfolio
          id:
            type: integer
            description: Portfolios' id
            minimum: 1
          identifier:
            type: string
          name:
            type: string
          active:
            type: boolean
            description: Indicates whether the portfolio is currently active or already archived
          favorited:
            type: boolean
            description: Indicates whether the portfolio is favorited by the current user
          statusExplanation:
            allOf:
            - $ref: '#/components/schemas/Formattable'
            - description: A text detailing and explaining why the portfolio has the reported status
          public:
            type: boolean
            description: Indicates whether the portfolio is accessible for everybody
          description:
            $ref: '#/components/schemas/Formattable'
          createdAt:
            type: string
            format: date-time
            description: Time of creation. Can be writable by admins with the `apiv3_write_readonly_attributes` setting enabled.
          updatedAt:
            type: string
            format: date-time
            description: Time of the most recent change to the portfolio
          _links:
            type: object
            required:
            - self
            - categories
            properties:
              update:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Form endpoint that aids in updating this portfolio


                    # Conditions


                    **Permission**: edit workspace'
              updateImmediately:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Directly update this portfolio


                    # Conditions


                    **Permission**: edit workspace'
              delete:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Delete this portfolio


                    # Conditions


                    **Permission**: admin'
              favor:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Mark this portfolio as favorited by the current user


                    # Conditions


                    Only present if the portfolio is not yet favorited


                    Permission**: none but login is required'
              disfavor:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Mark this portfolio as not favorited by the current user


                    # Conditions

                    Only present if the portfolio is favorited by the current user


                    Permission**: none but login is required'
              createWorkPackage:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Form endpoint that aids in preparing and creating a work package


                    # Conditions


                    **Permission**: add work packages'
              createWorkPackageImmediately:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Directly creates a work package in the portfolio


                    # Conditions


                    **Permission**: add work packages'
              self:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'This portfolio


                    **Resource**: Portfolio'
              categories:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Categories available in this portfolio


                    **Resource**: Collection'
              types:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Types available in this portfolio


                    **Resource**: Collection


                    # Conditions


                    **Permission**: view work packages or manage types'
              versions:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Versions available in this portfolio


                    **Resource**: Collection


                    # Conditions


                    **Permission**: view work packages or manage versions'
              memberships:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Memberships in the  portfolio


                    **Resource**: Collection


                    # Conditions


                    **Permission**: view members'
              workPackages:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Work Packages of this portfolio


                    **Resource**: Collection'
              parent:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Parent of the portfolio


                    **Resource**: Portfolio


                    # Conditions


                    **Permission** edit workspace'
              status:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Denotes the status of the portfolio, so whether the portfolio is on track, at risk or is having trouble.


                    **Resource**: ProjectStatus


                    # Conditions


                    **Permission** edit workspace'
              storages:
                type: array
                items:
                  allOf:
                  - $ref: '#/components/schemas/Link'
                  - description: 'The link to a storage that is active for this portfolio.


                      **Resource**: Storage


                      # Conditions


                      **Permission**: view_file_links'
              projectStorages:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'The project storage collection of this portfolio.


                    **Resource**: Collection


                    # Conditions


                    **Permission**: view_file_links'
              ancestors:
                type: array
                items:
                  allOf:
                  - $ref: '#/components/schemas/Link'
                  - description: 'A collection of links to the ancestor portfolios.


                      **Resource**: Portfolio'
    CustomCommentProperties:
      type: object
      patternProperties:
        ^customComment\d+$:
          type:
          - 'null'
          - string
          description: 'A plain-text comment associated with a project custom field that has comments enabled.


            The property is only present when the corresponding `customField{N}` has `has_comment` set to `true`.'
    CollectionModel:
      type: object
      required:
      - _type
      - total
      - count
      - _links
      properties:
        _type:
          type: string
          enum:
          - Collection
        total:
          type: integer
          description: The total amount of elements available in the collection.
          minimum: 0
        count:
          type: integer
          description: Actual amount of elements in this response.
          minimum: 0
        _links:
          $ref: '#/components/schemas/CollectionLinks'
    OffsetPaginatedCollectionModel:
      allOf:
      - $ref: '#/components/schemas/CollectionModel'
      - type: object
        required:
        - pageSize
        - offset
        - _links
        properties:
          pageSize:
            type: integer
            description: 'The amount of elements per page. If not set by the request this value defaults to the server''s system

              settings.'
            minimum: 0
          offset:
            type: integer
            description: The page offset indicating on which page the element collection starts.
            minimum: 0
          _links:
            $ref: '#/components/schemas/OffsetPaginatedCollectionLinks'
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic