openapi: 3.0.0
info:
  title: Craft.io Workspace API
  description: REST API providing access to workspace data including work items, custom
    fields, terminology, initiatives, products, epics, features, and stories within
    Craft.io product workspaces.
  version: 1.0.0
  contact:
    name: Craft.io Support
    url: https://help.craft.io/
    email: support@craft.io
servers:
- url: /
paths:
  /workspaces/{accountId}:
    get:
      operationId: GetWorkspaces
      responses:
        '200':
          description: A list of workspaces
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/Workspace'
                type: array
              examples:
                Example 1:
                  value:
                  - id: string
                    name: string
                    key: string
                  - id: string
                    name: string
                    key: string
        '400':
          description: Invalid account ID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
        '401':
          description: No access to account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
        '500':
          description: An error occurred while fetching workspaces
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
      description: Get the list of your account’s workspaces (workspace ID & name)
      tags:
      - Workspaces
      security:
      - api_key:
        - read:workspace-meta:craft
      parameters:
      - in: path
        name: accountId
        required: true
        schema:
          type: string
  /workspaces:
    get:
      operationId: GetWorkspacesByKey
      responses:
        '200':
          description: A list of workspaces
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/Workspace'
                type: array
              examples:
                Example 1:
                  value:
                  - id: string
                    name: string
                    key: string
                  - id: string
                    name: string
                    key: string
        '401':
          description: No access to account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
        '500':
          description: An error occurred while fetching workspaces
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
      description: Get the list of your account’s workspaces (workspace ID & name)
      tags:
      - Workspaces
      security:
      - api_key:
        - read:workspace-meta:craft
      parameters: []
  /workspace/{workspaceId}/custom_fields:
    get:
      operationId: GetCustomFields
      responses:
        '200':
          description: A list of workspace custom fields and their metadata
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/CustomField'
                type: array
        '400':
          description: Invalid account ID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
        '401':
          description: No access to account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
        '500':
          description: An error occurred while fetching custom fields
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
      description: Get the list of all workspace custom fields and their metadata
      tags:
      - Workspaces
      security:
      - api_key:
        - read:workspace-meta:craft
      parameters:
      - in: path
        name: workspaceId
        required: true
        schema:
          type: string
      - in: query
        name: includeOptions
        required: false
        schema:
          default: false
          type: boolean
  /workspace/{workspaceId}/terminology:
    get:
      operationId: GetTerminology
      responses:
        '200':
          description: A list of workspace entities terminology
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TerminologyList_Terminology_'
        '400':
          description: Invalid workspace ID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
        '401':
          description: No access to account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
        '500':
          description: An error occurred while fetching terminology
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
      description: Get the list of the workspace entities terminology
      tags:
      - Workspaces
      security:
      - api_key:
        - read:workspace-meta:craft
      parameters:
      - in: path
        name: workspaceId
        required: true
        schema:
          type: string
  /me/api-key:
    get:
      operationId: GetMyApiKey
      responses:
        '200':
          description: API key introspection
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiKeyIntrospection'
        '401':
          description: No valid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
      description: 'Returns the current API key''s authorization context — its bound
        user,

        granted scopes, and any resource-scope narrowing. Useful for AI clients

        (MCP) to hide tools that the key cannot use, instead of failing at the

        first request.'
      tags:
      - Introspection
      security:
      - api_key: []
      parameters: []
  /item/{itemId}:
    get:
      operationId: GetItem
      responses:
        '200':
          description: The item’s metadata
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Item'
        '400':
          description: Invalid item ID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
        '401':
          description: No access to account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
        '404':
          description: No item found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
        '500':
          description: An error occurred while fetching item
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
      description: Get a specific work item metadata by its ID
      tags:
      - Work Items and OKRs
      security:
      - api_key:
        - read:items:craft
      parameters:
      - in: path
        name: itemId
        required: true
        schema:
          type: string
      - description: Comma separated field list to be included in response, set "all"
          for all fields
        in: query
        name: fields
        required: false
        schema:
          type: string
    delete:
      operationId: DeleteItem
      responses:
        '200':
          description: The item’s metadata
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                required:
                - message
                type: object
        '400':
          description: Invalid item
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
        '401':
          description: No access to account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
        '404':
          description: No workspace found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
        '500':
          description: An error occurred while creating item
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
      description: Delete a work item
      tags:
      - Work Items and OKRs
      security:
      - api_key:
        - delete:items:craft
      parameters:
      - in: path
        name: itemId
        required: true
        schema:
          type: string
  /item/{itemId}/flat:
    get:
      operationId: GetItemFlat
      responses:
        '200':
          description: The item’s metadata
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ItemFlat'
              examples:
                Example 1:
                  value:
                    id: string
                    type: string
                    workspaceId: string
                    title: string
                    description: string
                    creationTime: '2022-09-16T06:26:01.000Z'
                    updateTime: '2023-06-14T13:54:34.792Z'
                    status_id: string
                    status_name: string
                    importance_id: string
                    importance_name: string
                    objective_id: string
                    objective_name: string
                    keyResult_id: string
                    keyResult_name: string
                    persona_id: string
                    persona_name: string
                    sprint_id: string
                    sprint_name: string
                    quarter_id: string
                    release_name: string
                    assignee_id: string
                    assignee_team: string
                    assignee_user: string
                    storyPoints: 0
                    estimatedHours: 0
                    actualStartDate: '2023-06-06T06:56:35.000Z'
                    actualEndDate: '2023-06-20T06:56:35.000Z'
                    devToolKey:
                      jira: string
                      ado: string
                      github: string
                      gitlab: string
                      pivotaltracker: string
                      targetprocess: string
                    parent_id: string
                    parent_title: string
                    parent_shortId: string
                    custom_2305843010172190992: string
                    custom_2305843010172191018: string
                    custom_2305843010172191132: string
                    custom_2305843010172191024: string
                    custom_2305843010172191022: string
                    custom_2305843010172191016: '2023-06-20T21:00:00.000Z'
                    custom_2305843010172171351: string
                    custom_2305843010172171349: string
                    custom_2305843010172171347: string
                    custom_2305843010172190959:
                    - string
                    labels:
                    - string
        '400':
          description: Invalid item ID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
        '401':
          description: No access to account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
        '404':
          description: No item found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
        '500':
          description: An error occurred while fetching item
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
      description: Get a specific work item metadata by its ID (flattened format)
      tags:
      - Work Items and OKRs
      security:
      - api_key:
        - read:items:craft
      parameters:
      - in: path
        name: itemId
        required: true
        schema:
          type: string
      - description: Comma separated field list to be included in response, set "all"
          for all fields
        in: query
        name: fields
        required: false
        schema:
          type: string
  /workspace/{workspaceId}/items:
    get:
      operationId: GetItems
      responses:
        '200':
          description: List of workspace items, OKRs and their metadata
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ItemsPaginated_Item_'
        '400':
          description: Invalid workspace ID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
        '401':
          description: No access to account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
        '500':
          description: An error occurred while fetching item list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
      description: Get all workspace working items and OKRs metadata by the workspace
        ID
      tags:
      - Work Items and OKRs
      security:
      - api_key:
        - read:items:craft
      parameters:
      - in: path
        name: workspaceId
        required: true
        schema:
          type: string
      - description: Comma separated field list to be included in response, set "all"
          for all fields
        in: query
        name: fields
        required: false
        schema:
          type: string
      - in: query
        name: page
        required: false
        schema:
          default: 1
          format: double
          type: number
      - in: query
        name: limit
        required: false
        schema:
          default: 50
          format: double
          type: number
      - description: Get list of items updated after this date (e.g. 2023-08-09T12:33:18.615Z
          )
        in: query
        name: updated_from
        required: false
        schema:
          format: date-time
          type: string
      - description: Get list of items updated before this date (e.g. 2023-09-09T23:22:10.531Z
          )
        in: query
        name: updated_to
        required: false
        schema:
          format: date-time
          type: string
      - description: Filter by item type (default term), comma separated
        in: query
        name: type
        required: false
        schema:
          type: string
      - description: Filter by parent/ancestor IDs (comma separated). MUST be internal
          numeric IDs (e.g. `2305843010635321210`), NOT shortIds like `CRK-25832`
          — the SQL casts to `::bigint[]`, so a shortId yields zero matches (200 with
          an empty list, no error). To resolve a shortId first, call the same list
          endpoint with `?shortId=<KEY-N>` to get the numeric id.
        in: query
        name: parents
        required: false
        schema:
          type: string
      - description: Case-insensitive substring search over title + description. Min
          2 chars; shorter values are ignored.
        in: query
        name: keyword
        required: false
        schema:
          type: string
      - description: Exact match on textual short id (e.g. `CRK-20091`). When supplied,
          takes precedence over `keyword` and resolves via the `(ct_craft_product__id,
          short_id)` unique index — sub-millisecond, returns at most one item.
        in: query
        name: shortId
        required: false
        schema:
          type: string
      - in: query
        name: status
        required: false
        schema:
          type: string
      - in: query
        name: importance
        required: false
        schema:
          type: string
      - in: query
        name: assignee
        required: false
        schema:
          type: string
      - in: query
        name: sprint
        required: false
        schema:
          type: string
      - in: query
        name: quarter
        required: false
        schema:
          type: string
      - in: query
        name: labels
        required: false
        schema:
          type: string
      - in: query
        name: createdBy
        required: false
        schema:
          type: string
      - in: query
        name: created_from
        required: false
        schema:
          format: date-time
          type: string
      - in: query
        name: created_to
        required: false
        schema:
          format: date-time
          type: string
  /workspace/{workspaceId}/items/flat:
    get:
      operationId: GetItemsFlat
      responses:
        '200':
          description: List of workspace items, OKRS and their metadata
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ItemsPaginated_ItemFlat_'
              examples:
                Example 1:
                  value:
                    items:
                    - id: string
                      type: string
                      workspaceId: string
                      title: string
                      description: string
                      creationTime: '2022-09-16T06:26:01.000Z'
                      updateTime: '2023-06-14T13:54:34.792Z'
                      status_id: string
                      status_name: string
                      importance_id: string
                      importance_name: string
                      objective_id: string
                      objective_name: string
                      keyResult_id: string
                      keyResult_name: string
                      persona_id: string
                      persona_name: string
                      sprint_id: string
                      sprint_name: string
                      quarter_id: string
                      release_name: string
                      assignee_id: string
                      assignee_team: string
                      assignee_user: string
                      storyPoints: 0
                      estimatedHours: 0
                      actualStartDate: '2023-06-06T06:56:35.000Z'
                      actualEndDate: '2023-06-20T06:56:35.000Z'
                      devToolKey:
                        jira: string
                        ado: string
                        github: string
                        gitlab: string
                        pivotaltracker: string
                        targetprocess: string
                      parent_id: string
                      parent_title: string
                      parent_shortId: string
                      custom_2305843010172190992: string
                      custom_2305843010172191018: string
                      custom_2305843010172191132: string
                      custom_2305843010172191024: string
                      custom_2305843010172191022: string
                      custom_2305843010172191016: '2023-06-20T21:00:00.000Z'
                      custom_2305843010172171351: string
                      custom_2305843010172171349: string
                      custom_2305843010172171347: string
                      custom_2305843010172190959:
                      - string
                      labels:
                      - string
                    metadata:
                      currentPage: 0
                      perPage: 0
                      totalPages: 0
                      totalRecords: 0
        '400':
          description: Invalid workspace ID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
        '401':
          description: No access to account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
        '500':
          description: An error occurred while fetching item list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
      description: Get all workspace working items and OKRs metadata by the workspace
        ID (flattened format)
      tags:
      - Work Items and OKRs
      security:
      - api_key:
        - read:items:craft
      parameters:
      - in: path
        name: workspaceId
        required: true
        schema:
          type: string
      - description: Comma separated field list to be included in response, set "all"
          for all fields
        in: query
        name: fields
        required: false
        schema:
          type: string
      - in: query
        name: page
        required: false
        schema:
          default: 1
          format: double
          type: number
      - in: query
        name: limit
        required: false
        schema:
          default: 50
          format: double
          type: number
      - description: Get list of items updated after this date (e.g. 2023-08-09T12:33:18.615Z
          )
        in: query
        name: updated_from
        required: false
        schema:
          format: date-time
          type: string
      - description: Get list of items updated before this date (e.g. 2023-09-09T23:22:10.531Z
          )
        in: query
        name: updated_to
        required: false
        schema:
          format: date-time
          type: string
      - description: Filter by item types (default term), comma separated
        in: query
        name: type
        required: false
        schema:
          type: string
      - description: Filter by parent/ancestor IDs (comma separated). MUST be internal
          numeric IDs (e.g. `2305843010635321210`), NOT shortIds like `CRK-25832`
          — the SQL casts to `::bigint[]`, so a shortId yields zero matches (200 with
          an empty list, no error). To resolve a shortId first, call the same list
          endpoint with `?shortId=<KEY-N>` to get the numeric id.
        in: query
        name: parents
        required: false
        schema:
          type: string
      - description: Case-insensitive substring search over title + description. Min
          2 chars; shorter values are ignored.
        in: query
        name: keyword
        required: false
        schema:
          type: string
      - description: Exact match on textual short id (e.g. `CRK-20091`). When supplied,
          takes precedence over `keyword` and resolves via the `(ct_craft_product__id,
          short_id)` unique index.
        in: query
        name: shortId
        required: false
        schema:
          type: string
      - in: query
        name: status
        required: false
        schema:
          type: string
      - in: query
        name: importance
        required: false
        schema:
          type: string
      - in: query
        name: assignee
        required: false
        schema:
          type: string
      - in: query
        name: sprint
        required: false
        schema:
          type: string
      - in: query
        name: quarter
        required: false
        schema:
          type: string
      - in: query
        name: labels
        required: false
        schema:
          type: string
      - in: query
        name: createdBy
        required: false
        schema:
          type: string
      - in: query
        name: created_from
        required: false
        schema:
          format: date-time
          type: string
      - in: query
        name: created_to
        required: false
        schema:
          format: date-time
          type: string
  /portfolio_item/{itemId}:
    get:
      operationId: GetInitiative
      responses:
        '200':
          description: The item’s metadata
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Initiative'
        '400':
          description: Invalid item ID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
        '401':
          description: No access to account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
        '404':
          description: No item found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
        '500':
          description: An error occurred while fetching item
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
      description: Get a specific portfolio item metadata by its ID
      tags:
      - Work Items and OKRs
      security:
      - api_key:
        - read:portfolios:craft
      parameters:
      - in: path
        name: itemId
        required: true
        schema:
          type: string
      - description: Comma separated field list to be included in response, set "all"
          for all fields
        in: query
        name: fields
        required: false
        schema:
          type: string
  /portfolio/{portfolioId}/items:
    get:
      operationId: GetInitiatives
      responses:
        '200':
          description: List of portfolio initiatives and their metadata
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ItemsPaginated_Initiative_'
        '400':
          description: Invalid portfolio ID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
        '401':
          description: No access to portfolio
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
        '500':
          description: An error occurred while fetching item list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
      description: Get all portfolio initiatives and OKRs metadata by the portfolio
        ID
      tags:
      - Work Items and OKRs
      security:
      - api_key:
        - read:portfolios:craft
      parameters:
      - in: path
        name: portfolioId
        required: true
        schema:
          type: string
      - description: Comma separated field list to be included in response, set "all"
          for all fields
        in: query
        name: fields
        required: false
        schema:
          type: string
      - in: query
        name: page
        required: false
        schema:
          default: 1
          format: double
          type: number
      - in: query
        name: limit
        required: false
        schema:
          default: 50
          format: double
          type: number
      - description: Get list of items updated after this date (e.g. 2023-08-09T12:33:18.615Z
          )
        in: query
        name: updated_from
        required: false
        schema:
          format: date-time
          type: string
      - description: Get list of items updated before this date (e.g. 2023-09-09T23:22:10.531Z
          )
        in: query
        name: updated_to
        required: false
        schema:
          format: date-time
          type: string
      - description: Filter by item type (default term)
        in: query
        name: type
        required: false
        schema:
          type: string
      - description: Filter by parent/ancestor IDs (comma separated). MUST be internal
          numeric IDs (e.g. `2305843010635321210`), NOT shortIds like `CRK-25832`
          — the SQL casts to `::bigint[]`, so a shortId yields zero matches (200 with
          an empty list, no error). To resolve a shortId first, call the same list
          endpoint with `?shortId=<KEY-N>` to get the numeric id.
        in: query
        name: parents
        required: false
        schema:
          type: string
      - description: Case-insensitive substring search over title + description. Min
          2 chars; shorter values are ignored.
        in: query
        name: keyword
        required: false
        schema:
          type: string
      - description: Exact match on textual short id (e.g. `CRK-20091`). When supplied,
          takes precedence over `keyword`.
        in: query
        name: shortId
        required: false
        schema:
          type: string
      - in: query
        name: status
        required: false
        schema:
          type: string
      - in: query
        name: importance
        required: false
        schema:
          type: string
      - in: query
        name: createdBy
        required: false
        schema:
          type: string
      - in: query
        name: created_from
        required: false
        schema:
          format: date-time
          type: string
      - in: query
        name: created_to
        required: false
        schema:
          format: date-time
          type: string
      - in: query
        name: sprint
        required: false
        schema:
          type: string
      - in: query
        name: quarter
        required: false
        schema:
          type: string
      - in: query
        name: labels
        required: false
        schema:
          type: string
      - in: query
        name: assignee
        required: false
        schema:
          type: string
  /item:
    post:
      operationId: CreateItem
      responses:
        '200':
          description: The item’s metadata
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Item'
        '400':
          description: Invalid item
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
        '401':
          description: No access to account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
        '404':
          description: No workspace found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
        '500':
          description: An error occurred while creating item
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
      description: Create a work item
      tags:
      - Work Items and OKRs
      security:
      - api_key:
        - write:items:craft
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ItemCreate'
    put:
      operationId: UpdateItem
      responses:
        '200':
          description: The item’s metadata
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Item'
        '400':
          description: Invalid item
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateErrorJSON'
        '401':
          description: No access to account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
        '404':
          description: No workspace found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
        '500':
          description: An error occurred while creating item
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralErrorResponse'
      description: Update a work item
      tags:
      - Work Items and OKRs
      security:
      - api_key:
        - write:items:craft
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ItemUpdate'
components:
  examples: {}
  headers: {}
  parameters: {}
  requestBodies: {}
  responses: {}
  schemas:
    Workspace:
      properties:
        id:
          type: string
        name:
          type: string
          nullable: true
        key:
          type: string
        webUrl:
          type: string
          description: Canonical Craft.io app URL for this workspace. Computed in
            PublishService.
      type: object
      additionalProperties: false
    GeneralErrorResponse:
      properties:
        message:
          type: string
      required:
      - message
      type: object
      additionalProperties: false
    CustomFieldOption:
      properties:
        id:
          type: string
        label:
          type: string
        startDate:
          type: string
          nullable: true
        endDate:
          type: string
          nullable: true
      required:
      - id
      - label
      type: object
      additionalProperties: false
    OptionShape:
      type: string
      enum:
      - select
      - date
      - date_range
    CustomField:
      properties:
        id:
          type: string
        name:
          type: string
        type:
          type: string
        values:
          items:
            type: string
          type: array
        options:
          items:
            $ref: '#/components/schemas/CustomFieldOption'
          type: array
        optionShape:
          $ref: '#/components/schemas/OptionShape'
      required:
      - id
      - name
      - type
      type: object
      additionalProperties: false
    Terminology:
      properties:
        category:
          type: string
        default:
          type: string
        customSingle:
          type: string
        customPlural:
          type: string
      required:
      - category
      - default
      - customSingle
      type: object
      additionalProperties: false
    TerminologyList_Terminology_:
      properties: {}
      type: object
      additionalProperties:
        $ref: '#/components/schemas/Terminology'
    Portfolio:
      properties:
        id:
          type: string
        name:
          type: string
          nullable: true
        workspaces:
          items:
            $ref: '#/components/schemas/Workspace'
          type: array
        webUrl:
          type: string
          description: Canonical Craft.io app URL for this portfolio. Computed in
            PublishService.
      required:
      - workspaces
      type: object
      additionalProperties: false
    SlackConnection:
      properties:
        workspaceId:
          type: string
        token:
          type: string
        slackTeamId:
          type: string
        slackInstallation:
          type: string
        isActive:
          type: boolean
      type: object
      additionalProperties: false
    SlackPortal:
      properties:
        workspaceId:
          type: string
        portalId:
          type: string
        portalName:
          type: string
        token:
          type: string
      type: object
      additionalProperties: false
    TeamInfo:
      properties:
        installation:
          $ref: '#/components/schemas/SlackConnection'
        portalList:
          items:
            $ref: '#/components/schemas/SlackPortal'
          type: array
      required:
      - installation
      - portalList
      type: object
      additionalProperties: false
    SlackTeamInfo:
      $ref: '#/components/schemas/TeamInfo'
    ConnectionUpdateRequest:
      properties:
        slackTeamId:
          type: string
        slackTeamName:
          type: string
        slackEnterpriseId:
          type: string
        slackEnterpriseName:
          type: string
        slackInstallation:
          type: string
      required:
      - slackInstallation
      type: object
      additionalProperties: false
    ApiKeyIntrospection:
      description: 'Introspection endpoints for "what is the current API key allowed
        to do".

        Used by clients (notably the MCP server) to self-filter the tools they expose.'
      properties:
        userId:
          type: string
          description: The user this key authenticates as.
        accountId:
          type: string
          description: The account this key belongs to.
        scopes:
          items:
            type: string
          type: array
          description: Granted granular scope strings (already normalized).
        resourceScope:
          properties:
            feedback_portals:
              items:
                type: string
              type: array
              nullable: true
            portfolios:
              items:
                type: string
              type: array
              nullable: true
            workspaces:
              items:
                type: string
              type: array
              nullable: true
          type: object
          description: 'Optional resource-scope narrowing. When a dimension is null/missing
            the key

            has access to every instance the bound user can see; when present it is
            the

            exclusive allowlist of ids on that dimension.'
        mcpAccess:
          type: boolean
      required:
      - userId
      - accountId
      - scopes
      - resourceScope
      - mcpAccess
      type: object
      additionalProperties: false
    Entity:
      properties:
        id:
          type: string
        name:
          type: string
          nullable: true
      type: object
      additionalProperties: false
    NullableType_Entity_:
      allOf:
      - $ref: '#/components/schemas/Entity'
      nullable: true
    NullableType_Entity-Array_:
      items:
        $ref: '#/components/schemas/Entity'
      type: array
      nullable: true
    Persona:
      properties:
        id:
          type: string
        name:
          type: string
          nullable: true
        position:
          type: string
      required:
      - position
      type: object
      additionalProperties: false
    NullableType_Persona_:
      allOf:
      - $ref: '#/components/schemas/Persona'
      nullable: true
    NullableType_Persona-Array_:
      items:
        $ref: '#/components/schemas/Persona'
      type: array
      nullable: true
    EntityWithDates:
      properties:
        id:
          type: string
        name:
          type: string
          nullable: true
        startDate:
          type: string
          nullable: true
        endDate:
          type: string
          nullable: true
      type: object
      additionalProperties: false
    NullableType_EntityWithDates_:
      allOf:
      - $ref: '#/components/schemas/EntityWithDates'
      nullable: true
    EntityWithTerminology:
      properties:
        id:
          type: string
        name:
          type: string
          nullable: true
        customTermName:
          type: string
      type: object
      additionalProperties: false
    NullableType_EntityWithTerminology-and-EntityWithDates_:
      allOf:
      - $ref: '#/components/schemas/EntityWithTerminology'
      - $ref: '#/components/schemas/EntityWithDates'
      nullable: true
    Assignee:
      properties:
        id:
          type: string
        team:
          type: string
        user:
          type: string
      required:
      - id
      - team
      type: object
      additionalProperties: false
    NullableType_Assignee_:
      allOf:
      - $ref: '#/components/schemas/Assignee'
      nullable: true
    EntityParent:
      properties:
        id:
          type: string
        title:
          type: string
        shortId:
          type: string
        webUrl:
          type: string
          description: Direct link to the parent item in the Craft.io app.
      required:
      - id
      type: object
      additionalProperties: false
    NullableType_EntityParent_:
      allOf:
      - $ref: '#/components/schemas/EntityParent'
      nullable: true
    NullableType_string_:
      type: string
      nullable: true
    NullableType_string-Array_:
      items:
        type: string
      type: array
      nullable: true
    CustomFieldValue:
      properties:
        id:
          type: string
        name:
          type: string
        value:
          $ref: '#/components/schemas/NullableType_string_'
        values:
          $ref: '#/components/schemas/NullableType_string-Array_'
        label:
          type: string
      required:
      - id
      type: object
      additionalProperties: false
    OutIn:
      properties:
        quarter:
          type: boolean
        sprint:
          type: boolean
      type: object
      additionalProperties: false
    Dependency:
      properties:
        id:
          type: string
        name:
          type: string
        value:
          type: string
          enum:
          - blocks
          - blocked by
          - related
        workspaceId:
          type: string
        portfolioId:
          type: string
      required:
      - id
      - value
      type: object
      additionalProperties: false
    NullableType__id%3F%3Astring.name%3F%3Astring__:
      properties:
        name:
          type: string
        id:
          type: string
      type: object
      nullable: true
    FeedbackLink:
      properties:
        id:
          type: string
        shortId:
          type: string
        title:
          type: string
        status:
          $ref: '#/components/schemas/NullableType__id%3F%3Astring.name%3F%3Astring__'
        webUrl:
          type: string
          description: Direct link into the feedback portal for this linked feedback
            item.
      type: object
      additionalProperties: false
    NullableType_FeedbackLink-Array_:
      items:
        $ref: '#/components/schemas/FeedbackLink'
      type: array
      nullable: true
    NullableType_Date_:
      type: string
      format: date-time
      nullable: true
    DevToolKeyList:
      properties:
        jira:
          type: string
        ado:
          type: string
        github:
          type: string
        gitlab:
          type: string
        pivotaltracker:
          type: string
        targetprocess:
          type: string
      type: object
      additionalProperties: false
    Item:
      properties:
        id:
          $ref: '#/components/schemas/NullableType_string_'
        type:
          type: string
        workspaceId:
          type: string
        portfolioId:
          type: string
        shortId:
          type: string
        title:
          type: string
        description:
          type: string
          nullable: true
        creationTime:
          type: string
          format: date-time
        updateTime:
          type: string
          format: date-time
        storyPoints:
          type: number
          format: double
        initiativeId:
          $ref: '#/components/schemas/NullableType_string_'
        value:
          type: number
          format: double
        effort:
          type: number
          format: double
        kano:
          type: string
        estimatedHours:
          type: number
          format: double
        labels:
          items:
            type: string
          type: array
        actualStartDate:
          $ref: '#/components/schemas/NullableType_Date_'
        actualEndDate:
          $ref: '#/components/schemas/NullableType_Date_'
        devToolKey:
          $ref: '#/components/schemas/DevToolKeyList'
        webUrl:
          type: string
          description: Canonical Craft.io app URL for this item. Computed in PublishService.
        status:
          $ref: '#/components/schemas/NullableType_Entity_'
        importance:
          $ref: '#/components/schemas/NullableType_Entity_'
        objective:
          $ref: '#/components/schemas/NullableType_Entity_'
        keyResult:
          $ref: '#/components/schemas/NullableType_Entity_'
        objectives:
          $ref: '#/components/schemas/NullableType_Entity-Array_'
        keyResults:
          $ref: '#/components/schemas/NullableType_Entity-Array_'
        persona:
          $ref: '#/components/schemas/NullableType_Persona_'
        personas:
          $ref: '#/components/schemas/NullableType_Persona-Array_'
        sprint:
          $ref: '#/components/schemas/NullableType_EntityWithDates_'
        quarter:
          $ref: '#/components/schemas/NullableType_EntityWithTerminology-and-EntityWithDates_'
        assignee:
          $ref: '#/components/schemas/NullableType_Assignee_'
        parent:
          $ref: '#/components/schemas/NullableType_EntityParent_'
        createdBy:
          $ref: '#/components/schemas/Entity'
        customFields:
          items:
            $ref: '#/components/schemas/CustomFieldValue'
          type: array
        outIn:
          $ref: '#/components/schemas/OutIn'
        dependencies:
          items:
            $ref: '#/components/schemas/Dependency'
          type: array
        feedbackLinks:
          $ref: '#/components/schemas/NullableType_FeedbackLink-Array_'
      type: object
      additionalProperties: false
    ItemFlat:
      properties:
        id:
          $ref: '#/components/schemas/NullableType_string_'
        type:
          type: string
        workspaceId:
          type: string
        portfolioId:
          type: string
        shortId:
          type: string
        title:
          type: string
        description:
          type: string
          nullable: true
        creationTime:
          type: string
          format: date-time
        updateTime:
          type: string
          format: date-time
        storyPoints:
          type: number
          format: double
        initiativeId:
          $ref: '#/components/schemas/NullableType_string_'
        value:
          type: number
          format: double
        effort:
          type: number
          format: double
        kano:
          type: string
        estimatedHours:
          type: number
          format: double
        labels:
          items:
            type: string
          type: array
        actualStartDate:
          $ref: '#/components/schemas/NullableType_Date_'
        actualEndDate:
          $ref: '#/components/schemas/NullableType_Date_'
        devToolKey:
          $ref: '#/components/schemas/DevToolKeyList'
        webUrl:
          type: string
          description: Canonical Craft.io app URL for this item. Computed in PublishService.
        status_id:
          type: string
        status_name:
          type: string
        importance_id:
          type: string
        importance_name:
          type: string
        objective_id:
          type: string
        objective_name:
          type: string
        keyResult_id:
          type: string
        keyResult_name:
          type: string
        persona_id:
          type: string
        persona_name:
          type: string
        sprint_id:
          type: string
        sprint_name:
          type: string
        quarter_id:
          type: string
        quarter_name:
          type: string
        assignee_id:
          type: string
        assignee_team:
          type: string
        assignee_user:
          type: string
        parent_id:
          type: string
          nullable: true
        parent_name:
          type: string
          nullable: true
        parent_shortId:
          type: string
          nullable: true
        devToolKey_jira:
          type: string
        devToolKey_ado:
          type: string
        devToolKey_github:
          type: string
        devToolKey_gitlab:
          type: string
        devToolKey_pivotaltracker:
          type: string
        devToolKey_targetprocess:
          type: string
        sprint_startDate:
          type: string
          nullable: true
        sprint_endDate:
          type: string
          nullable: true
        quarter_startDate:
          type: string
          nullable: true
        quarter_endDate:
          type: string
          nullable: true
      type: object
      additionalProperties:
        anyOf:
        - type: string
        - items:
            type: string
          type: array
        - type: boolean
        - type: string
          format: date-time
        - type: number
          format: double
        - $ref: '#/components/schemas/DevToolKeyList'
        nullable: true
    PaginationMetadata:
      properties:
        currentPage:
          type: number
          format: double
        perPage:
          type: number
          format: double
        totalPages:
          type: number
          format: double
        totalRecords:
          type: number
          format: double
      required:
      - currentPage
      - perPage
      - totalPages
      - totalRecords
      type: object
      additionalProperties: false
    ItemsPaginated_Item_:
      properties:
        items:
          items:
            $ref: '#/components/schemas/Item'
          type: array
        metadata:
          $ref: '#/components/schemas/PaginationMetadata'
      required:
      - items
      - metadata
      type: object
      additionalProperties: false
    ItemsPaginated_ItemFlat_:
      properties:
        items:
          items:
            $ref: '#/components/schemas/ItemFlat'
          type: array
        metadata:
          $ref: '#/components/schemas/PaginationMetadata'
      required:
      - items
      - metadata
      type: object
      additionalProperties: false
    ? Pick_Item.Exclude_keyofItem.workspaceId-or-initiativeId-or-sprint-or-quarter-or-assignee-or-storyPoints-or-estimatedHours-or-objective-or-keyResult-or-persona-or-personas-or-parent-or-labels-or-kano__
    : properties:
        status:
          $ref: '#/components/schemas/NullableType_Entity_'
        importance:
          $ref: '#/components/schemas/NullableType_Entity_'
        objectives:
          $ref: '#/components/schemas/NullableType_Entity-Array_'
        keyResults:
          $ref: '#/components/schemas/NullableType_Entity-Array_'
        createdBy:
          $ref: '#/components/schemas/Entity'
        customFields:
          items:
            $ref: '#/components/schemas/CustomFieldValue'
          type: array
        outIn:
          $ref: '#/components/schemas/OutIn'
        dependencies:
          items:
            $ref: '#/components/schemas/Dependency'
          type: array
        feedbackLinks:
          $ref: '#/components/schemas/NullableType_FeedbackLink-Array_'
        id:
          $ref: '#/components/schemas/NullableType_string_'
        type:
          type: string
        portfolioId:
          type: string
        shortId:
          type: string
        title:
          type: string
        description:
          type: string
          nullable: true
        creationTime:
          type: string
          format: date-time
        updateTime:
          type: string
          format: date-time
        value:
          type: number
          format: double
        effort:
          type: number
          format: double
        actualStartDate:
          $ref: '#/components/schemas/NullableType_Date_'
        actualEndDate:
          $ref: '#/components/schemas/NullableType_Date_'
        devToolKey:
          $ref: '#/components/schemas/DevToolKeyList'
        webUrl:
          type: string
          description: Canonical Craft.io app URL for this item. Computed in PublishService.
      type: object
      description: From T, pick a set of properties whose keys are in the union K
    ? Omit_Item.workspaceId-or-initiativeId-or-sprint-or-quarter-or-assignee-or-storyPoints-or-estimatedHours-or-objective-or-keyResult-or-persona-or-personas-or-parent-or-labels-or-kano_
    : $ref: '#/components/schemas/Pick_Item.Exclude_keyofItem.workspaceId-or-initiativeId-or-sprint-or-quarter-or-assignee-or-storyPoints-or-estimatedHours-or-objective-or-keyResult-or-persona-or-personas-or-parent-or-labels-or-kano__'
      description: Construct a type with the properties of T except for those in type
        K.
    Initiative:
      $ref: '#/components/schemas/Omit_Item.workspaceId-or-initiativeId-or-sprint-or-quarter-or-assignee-or-storyPoints-or-estimatedHours-or-objective-or-keyResult-or-persona-or-personas-or-parent-or-labels-or-kano_'
    ItemsPaginated_Initiative_:
      properties:
        items:
          items:
            $ref: '#/components/schemas/Initiative'
          type: array
        metadata:
          $ref: '#/components/schemas/PaginationMetadata'
      required:
      - items
      - metadata
      type: object
      additionalProperties: false
    EntityId:
      properties:
        id:
          type: string
      type: object
      additionalProperties: false
    NullableType_EntityId_:
      allOf:
      - $ref: '#/components/schemas/EntityId'
      nullable: true
    NullableType_EntityId-Array_:
      items:
        $ref: '#/components/schemas/EntityId'
      type: array
      nullable: true
    ItemCreate:
      properties:
        type:
          type: string
        workspaceId:
          type: string
        title:
          type: string
        parent:
          $ref: '#/components/schemas/NullableType_EntityId_'
        description:
          type: string
          nullable: true
        storyPoints:
          type: number
          format: double
        initiativeId:
          $ref: '#/components/schemas/NullableType_string_'
        value:
          type: number
          format: double
        effort:
          type: number
          format: double
        kano:
          type: string
        estimatedHours:
          type: number
          format: double
        labels:
          items:
            type: string
          type: array
        actualStartDate:
          $ref: '#/components/schemas/NullableType_Date_'
        actualEndDate:
          $ref: '#/components/schemas/NullableType_Date_'
        status:
          $ref: '#/components/schemas/NullableType_EntityId_'
        importance:
          $ref: '#/components/schemas/NullableType_EntityId_'
        objectives:
          $ref: '#/components/schemas/NullableType_EntityId-Array_'
        keyResults:
          $ref: '#/components/schemas/NullableType_EntityId-Array_'
        persona:
          $ref: '#/components/schemas/NullableType_EntityId_'
        personas:
          $ref: '#/components/schemas/NullableType_EntityId-Array_'
        sprint:
          $ref: '#/components/schemas/NullableType_EntityId_'
        quarter:
          $ref: '#/components/schemas/NullableType_EntityId_'
        assignee:
          $ref: '#/components/schemas/NullableType_Assignee_'
        customFields:
          items:
            $ref: '#/components/schemas/CustomFieldValue'
          type: array
        outIn:
          $ref: '#/components/schemas/OutIn'
      required:
      - type
      - workspaceId
      - title
      - parent
      type: object
      additionalProperties: false
    ValidateErrorJSON:
      properties:
        message:
          type: string
        details:
          properties: {}
          additionalProperties: {}
          type: object
      required:
      - message
      - details
      type: object
      additionalProperties: false
    ItemUpdate:
      properties:
        id:
          type: string
        title:
          type: string
        parent:
          $ref: '#/components/schemas/NullableType_EntityId_'
        description:
          type: string
          nullable: true
        storyPoints:
          type: number
          format: double
        initiativeId:
          $ref: '#/components/schemas/NullableType_string_'
        value:
          type: number
          format: double
        effort:
          type: number
          format: double
        kano:
          type: string
        estimatedHours:
          type: number
          format: double
        labels:
          items:
            type: string
          type: array
        actualStartDate:
          $ref: '#/components/schemas/NullableType_Date_'
        actualEndDate:
          $ref: '#/components/schemas/NullableType_Date_'
        status:
          $ref: '#/components/schemas/NullableType_EntityId_'
        importance:
          $ref: '#/components/schemas/NullableType_EntityId_'
        objectives:
          $ref: '#/components/schemas/NullableType_EntityId-Array_'
        keyResults:
          $ref: '#/components/schemas/NullableType_EntityId-Array_'
        persona:
          $ref: '#/components/schemas/NullableType_EntityId_'
        personas:
          $ref: '#/components/schemas/NullableType_EntityId-Array_'
        sprint:
          $ref: '#/components/schemas/NullableType_EntityId_'
        quarter:
          $ref: '#/components/schemas/NullableType_EntityId_'
        assignee:
          $ref: '#/components/schemas/NullableType_Assignee_'
        customFields:
          items:
            $ref: '#/components/schemas/CustomFieldValue'
          type: array
        outIn:
          $ref: '#/components/schemas/OutIn'
      required:
      - id
      type: object
      additionalProperties: false
    FeedbackPortal:
      properties:
        id:
          type: string
        name:
          type: string
          nullable: true
        url:
          type: string
        workspaces:
          items:
            $ref: '#/components/schemas/Workspace'
          type: array
        webUrl:
          type: string
          description: Fully-qualified portal URL (https://{slug}.{FPURL}). Convenience
            over `url`.
      type: object
      additionalProperties: false
    PortalImportance:
      properties:
        id:
          type: string
        name:
          type: string
        isDefault:
          type: boolean
          description: True when this importance is the portal's default — used by
            create_feedback when `importanceId` is omitted.
      required:
      - id
      - name
      type: object
      additionalProperties: false
    Category:
      properties:
        id:
          type: string
        name:
          type: string
      required:
      - id
      - name
      type: object
      additionalProperties: false
    Person:
      properties:
        id:
          type: string
        name:
          type: string
          nullable: true
        email:
          type: string
      type: object
      additionalProperties: false
    LinkedItem:
      properties:
        id:
          type: string
        shortId:
          type: string
        title:
          type: string
        webUrl:
          type: string
          description: Direct link to the linked work item in the Craft.io app.
      type: object
      additionalProperties: false
    NullableType_LinkedItem-Array_:
      items:
        $ref: '#/components/schemas/LinkedItem'
      type: array
      nullable: true
    BaseFeedbackItem:
      properties:
        id:
          type: string
        portalId:
          type: string
        shortId:
          type: string
        title:
          type: string
        description:
          type: string
        creationTime:
          type: string
          format: date-time
        category:
          $ref: '#/components/schemas/Category'
        owner:
          $ref: '#/components/schemas/Person'
        createdBy:
          $ref: '#/components/schemas/Person'
        status:
          $ref: '#/components/schemas/Entity'
        internalStatus:
          $ref: '#/components/schemas/Entity'
        importance:
          $ref: '#/components/schemas/Entity'
        labels:
          items:
            type: string
          type: array
        customFields:
          items:
            $ref: '#/components/schemas/CustomFieldValue'
          type: array
        linkedItems:
          $ref: '#/components/schemas/NullableType_LinkedItem-Array_'
        webUrl:
          type: string
          description: Direct link into the feedback portal for this feedback item.
      required:
      - id
      type: object
      additionalProperties: false
    FeedbackItem:
      $ref: '#/components/schemas/BaseFeedbackItem'
    FeedbackItemsPaginated_FeedbackItem_:
      properties:
        items:
          items:
            $ref: '#/components/schemas/FeedbackItem'
          type: array
        metadata:
          $ref: '#/components/schemas/PaginationMetadata'
      required:
      - items
      - metadata
      type: object
      additionalProperties: false
    PlainIdeaRequest:
      properties:
        workspaceId:
          type: string
        title:
          type: string
        description:
          type: string
        owner:
          type: string
          description: "Email address of the idea author. The backend looks up (or\
            \ creates) the\r\nperson record from this email and attributes the feedback\
            \ to them. This\r\nis NOT a user ID — sending a numeric ID will return\
            \ 400."
          example: user@example.com
        categoryId:
          type: string
        labels:
          items:
            type: string
          type: array
        importanceId:
          type: string
          description: "Portal importance — numeric ID OR exact name (case-insensitive).\
            \ When\r\nomitted, the portal's `isDefault: true` importance is used (see\r\
            \n`GET /feedback_portal/{portalId}/importances`)."
          example: Critical
      required:
      - title
      type: object
      additionalProperties: false
    IdeaRequest:
      properties:
        workspaceId:
          type: string
        title:
          type: string
        description:
          type: string
        owner:
          type: string
          description: "Email address of the idea author. The backend looks up (or\
            \ creates) the\r\nperson record from this email and attributes the feedback\
            \ to them. This\r\nis NOT a user ID — sending a numeric ID will return\
            \ 400."
          example: user@example.com
        categoryId:
          type: string
        labels:
          items:
            type: string
          type: array
        importanceId:
          type: string
          description: "Portal importance — numeric ID OR exact name (case-insensitive).\
            \ When\r\nomitted, the portal's `isDefault: true` importance is used (see\r\
            \n`GET /feedback_portal/{portalId}/importances`)."
          example: Critical
        customFields:
          items:
            $ref: '#/components/schemas/CustomFieldValue'
          type: array
      required:
      - title
      type: object
      additionalProperties: false
    FormCustomField:
      properties:
        id:
          type: string
        name:
          type: string
        type:
          type: string
        values:
          items:
            type: string
          type: array
        options:
          items:
            $ref: '#/components/schemas/CustomFieldOption'
          type: array
        optionShape:
          $ref: '#/components/schemas/OptionShape'
        required:
          type: boolean
      required:
      - id
      - name
      - type
      - required
      type: object
      additionalProperties: false
    PortalForm:
      properties:
        id:
          type: string
        name:
          type: string
        categories:
          items:
            $ref: '#/components/schemas/Entity'
          type: array
        fields:
          items:
            $ref: '#/components/schemas/FormCustomField'
          type: array
      required:
      - id
      - name
      - categories
      - fields
      type: object
      additionalProperties: false
  securitySchemes:
    api_key:
      type: apiKey
      in: header
      name: x-api-key
tags:
- name: Workspaces
  description: Workspaces are the areas where product teams are managing the full
    lifecycle of their products
- name: Work Items and OKRs
  description: Work items are the main building blocks of your product’s roadmap,
    and include Products, Epics, Features and Sub Features.<br /> OKRs are the goal-setting
    framework of your product’s roadmap, and include Objectives and Key Results.