openproject/docs/api/apiv3/paths/custom_option.yml

# /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/custom_option_model.yml"
      description: OK
      headers: {}
    '404':
      content:
        application/hal+json:
          schema:
            $ref: "../components/schemas/error_response.yml"
          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