CRcraft
Workspaces

GET /workspace/{workspaceId}/custom_fields

Changed on

Get the list of all workspace custom fields and their metadata

Request

  • Base URL
    https://api.craft.io
  • URL
    https://api.craft.io/workspace/{workspaceId}/custom_fields
  • Auth
    API key in header x-api-key

Path parameters

workspaceIdstring required

Query parameters

includeOptionsboolean

Response

A list of workspace custom fields and their metadata

idstring required
namestring required
typestring required
capacityEnabledboolean

NUMBER fields only: true when the container plans capacity against this field. A capacity field (FE, BE) is otherwise indistinguishable from any other number (Reach, ACV) here. Read the limits with /capacity.

categoryIdstring nullable
categoryNamestring nullable
valuesstring[]
optionShape'select' | 'date' | 'date_range'
multiboolean
source'portal' | 'workspace'

Changes

  • 6009bb084cb5Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 9388f8d7ecd8Revision changes
    • info

      added the optional property / to the response with the status