Custom Fields

Get Space Custom Fields

Changed on

View the Custom Fields you have access to in a specific Space. Get Space Custom Fields only returns Custom Fields created at the Space level. Custom Fields created at the Folder and List level are not included.

Custom Fields scoped to specific custom task types include an applied_objects array on each field object. Each entry has object_type (19 for custom task type) and object_id (the custom task type ID, matching custom_item_id on tasks). Use Get Custom Task Types to resolve IDs to names. Fields without task-type scoping omit applied_objects. Workspace-scoped Custom Fields are included when querying a Space.

get/v2/space/{space_id}/field

Request

  • Base URL
    https://api.clickup.com/api
  • URL
    https://api.clickup.com/api/v2/space/{space_id}/field
  • Auth
    API key in header Authorization

Path parameters

space_idnumber required
Example:123

Query parameters

include_applied_objectsboolean
Example:true

When true, includes applied_objects on task-type-scoped Custom Fields in the response.

Headers

Content-Type'application/json' required
Example:application/json

Response

fieldsItems[] required(unresolved $ref)

Changes

    • breaking

      the / response's property type changed from no type to object for status

    • info

      added the optional property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status