OpenProject

OpenProject Statuses API

The statuses endpoints return collections or single entities of type `Status`. The following tables list the different properties of `Status` entities. ## Linked Properties | Link | Description | Type | Constraints | Supported operations | |:----:|-------------|--------|-------------|----------------------| | self | This status | Status | not null | READ | ## Local Properties | Property | Description | Type | Constraints | Supported operations | |:------------------:|--------------------------------------------------------------------------------------------------------------------------------------------|---------|---------------|----------------------| | id | Status id | Integer | x > 0 | READ | | name | Status name | String | | READ | | isClosed | Indicates, whether work package of this status are considered closed | Boolean | | READ | | color | A Hex-coded value of the color assigned to the status. | String | | READ | | isDefault | True, if this status is the default status for new work packages | Boolean | | READ | | isReadonly | Indicates, whether work package of this status are readonly | Boolean | | READ | | excludedFromTotals | Indicates, whether work package of this status are excluded from totals of`Work`, `Remaining work`, and `% Complete` in a hierarchy. | Boolean | | READ | | defaultDoneRatio | The percentageDone being applied when changing to this status | Integer | 0 <= x <= 100 | READ | | position | Sort index of the status | Integer | | READ |

GitHub OpenAPI

Operations 2

GET /api/v3/statuses List the collection of all statuses #
GET /api/v3/statuses/{id} Get a work package status #

Documentation

📖
Documentation
https://www.openproject.org/docs/api/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/openproject/refs/heads/main/openapi/openproject-statuses-api-openapi.yml

Other Resources

🔗
Introduction
https://www.openproject.org/docs/api/introduction/
🔗
Endpoints
https://www.openproject.org/docs/api/endpoints/
🔗
GitHub
https://github.com/opf/openproject

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/openproject-statuses-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openproject-statuses-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: You're looking at the current **stable** documentation of the OpenProject APIv3.
  title: OpenProject API V3 (Stable) Statuses 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: Statuses
  description: The statuses endpoints return collections or single entities of type `Status`.
paths:
  /api/v3/statuses:
    get:
      summary: List the collection of all statuses
      operationId: list_statuses
      tags:
      - Statuses
      description: Returns a collection of all work package statuses.
      responses:
        '200':
          description: OK
          content:
            application/hal+json:
              examples:
                simple status collection:
                  $ref: '#/components/examples/StatusCollection'
              schema:
                $ref: '#/components/schemas/StatusCollectionModel'
        '403':
          description: 'Returned if the client does not have sufficient permissions.


            **Required permission:** view work package (on any project)'
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                response:
                  value:
                    _type: Error
                    errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
                    message: You are not allowed to see the statuses.
  /api/v3/statuses/{id}:
    get:
      summary: Get a work package status
      operationId: get_status
      tags:
      - Statuses
      description: Returns a work package status by its unique identifier.
      parameters:
      - name: id
        description: Status id
        in: path
        required: true
        schema:
          type: integer
        example: 1
      responses:
        '200':
          description: OK
          content:
            application/hal+json:
              examples:
                response:
                  $ref: '#/components/examples/StatusResponse'
              schema:
                $ref: '#/components/schemas/StatusModel'
        '403':
          description: 'Returned if the client does not have sufficient permissions.


            **Required permission:** view work package (on any project)'
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                response:
                  value:
                    _type: Error
                    errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
                    message: You are not allowed to see this status.
        '404':
          description: Returned if the status does not exist.
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                response:
                  value:
                    _type: Error
                    errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
                    message: The requested resource could not be found.
components:
  examples:
    StatusResponse:
      description: A standard status resource response.
      value:
        _type: Status
        id: 13
        name: Waiting for Darth-approval
        isClosed: false
        color: '#FE005D'
        isDefault: false
        isReadonly: false
        excludedFromTotals: false
        defaultDoneRatio: 66
        position: 4
        _links:
          self:
            href: /api/v3/statuses/13
            title: Waiting for Darth-approval
    StatusCollection:
      description: A standard, unpaginated collection of statuses.
      value:
        _type: Collection
        count: 6
        total: 6
        _embedded:
          elements:
          - _type: Status
            id: 1
            name: New
            isClosed: false
            color: '#3997AD'
            isDefault: true
            isReadonly: false
            excludedFromTotals: false
            defaultDoneRatio: 0
            position: 1
            _links:
              self:
                href: /api/v3/statuses/1
          - _type: Status
            id: 3
            name: Resolved
            isClosed: false
            color: '#93D2AE'
            isDefault: false
            isReadonly: false
            excludedFromTotals: false
            defaultDoneRatio: 75
            position: 3
            _links:
              self:
                href: /api/v3/statuses/3
          - _type: Status
            id: 4
            name: Feedback
            isClosed: false
            color: '#A96FFE'
            isDefault: false
            isReadonly: false
            excludedFromTotals: false
            defaultDoneRatio: 25
            position: 4
            _links:
              self:
                href: /api/v3/statuses/4
          - _type: Status
            id: 5
            name: Closed
            isClosed: true
            color: '#DF6DA1'
            isDefault: false
            isReadonly: false
            excludedFromTotals: false
            defaultDoneRatio: 100
            position: 5
            _links:
              self:
                href: /api/v3/statuses/5
          - _type: Status
            id: 6
            name: Rejected
            isClosed: true
            color: '#D32937'
            isDefault: false
            isReadonly: true
            excludedFromTotals: true
            defaultDoneRatio: 100
            position: 6
            _links:
              self:
                href: /api/v3/statuses/6
          - _type: Status
            id: 2
            name: In Progress
            isClosed: false
            color: '#3852C6'
            isDefault: false
            isReadonly: false
            excludedFromTotals: false
            defaultDoneRatio: 50
            position: 3
            _links:
              self:
                href: /api/v3/statuses/2
        _links:
          self:
            href: /api/v3/statuses
  schemas:
    CollectionLinks:
      type: object
      required:
      - self
      properties:
        self:
          allOf:
          - $ref: '#/components/schemas/Link'
          - description: 'This collection resource.


              **Resource**: Collection'
    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
    StatusCollectionModel:
      allOf:
      - $ref: '#/components/schemas/CollectionModel'
      - type: object
        required:
        - _embedded
        properties:
          _embedded:
            type: object
            required:
            - elements
            properties:
              elements:
                type: array
                items:
                  $ref: '#/components/schemas/StatusModel'
    StatusModel:
      type: object
      properties:
        _type:
          type: string
          enum:
          - Status
        id:
          type: integer
          description: Status id
          minimum: 1
        name:
          type: string
          description: Status name
        isClosed:
          type: boolean
          description: Indicates, whether work package of this status are considered closed
        color:
          type:
          - string
          - 'null'
          format: hex-code
          description: The color of the status
        isDefault:
          type: boolean
          description: True, if this status is the default status for new work packages
        isReadonly:
          type: boolean
          description: Indicates, whether work package of this status are readonly
        excludedFromTotals:
          type: boolean
          description: 'Indicates, whether work package of this status are excluded from totals of `Work`, `Remaining work`, and

            `% Complete` in a hierarchy.'
        defaultDoneRatio:
          type: integer
          description: The percentageDone being applied when changing to this status
          minimum: 0
          maximum: 100
        position:
          type: integer
          description: Sort index of the status
        _links:
          type: object
          required:
          - self
          properties:
            self:
              allOf:
              - $ref: '#/components/schemas/Link'
              - description: 'This status


                  **Resource**: Status'
    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.
    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'
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic