OpenProject

OpenProject Custom Options API

The custom options endpoints return collections or single entities of type `CustomOption`. The following tables list the different properties of `CustomOption` entities. ## Linked Properties | Link | Description | Type | Constraints | Supported operations | |:-------------:|-------------------------- | ------------- | ----------- | -------------------- | | self | This custom option | CustomOption | not null | READ | ## Local Properties | Property | Description | Type | Constraints | Supported operations | |:----------------:| ---------------------------------------------- | -------- | ----------- | -------------------- | | id | The identifier | Integer | | READ | | value | The value defined for this custom option | String | | READ | custom options are options of list custom fields.

Documentation GitHub OpenAPI

Operations 1

GET /api/v3/custom_options/{id} View Custom Option #

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:openproject-custom-options-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

openapi: 3.2.0
info:
  description: You're looking at the current **stable** documentation of the OpenProject APIv3.
  title: OpenProject API V3 (Stable) Custom Options 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:
- description: The custom options endpoints return collections or single entities of type `CustomOption`.
  name: Custom Options
paths:
  /api/v3/custom_options/{id}:
    get:
      parameters:
      - description: The custom option's identifier
        example: '1'
        in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/hal+json:
              examples:
                response:
                  value:
                    _links:
                      self:
                        href: /api/v3/custom_options/1
                    _type: CustomOption
                    value: Foo
              schema:
                $ref: '#/components/schemas/CustomOptionModel'
          description: OK
          headers: {}
        '404':
          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.
          description: 'Returned if the custom option does not exist or the client does not have sufficient permissions to see it.


            **Required permission:** view work package in any project the custom option''s custom field is active in.'
          headers: {}
      tags:
      - Custom Options
      description: ''
      operationId: View_Custom_Option
      summary: View Custom Option
components:
  schemas:
    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
    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.
    CustomOptionModel:
      type: object
      properties:
        id:
          type: integer
          description: The identifier
          readOnly: true
        value:
          type: string
          description: The value defined for this custom option
          readOnly: true
        _links:
          type: object
          required:
          - self
          properties:
            self:
              allOf:
              - $ref: '#/components/schemas/Link'
              - description: 'This custom option.


                  **Resource**: CustomOption'
                readOnly: true
      example:
        _links:
          self:
            href: /api/v3/custom_options/1
        _type: CustomOption
        value: Foo
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic