API Docs

Get custom fields

Get all custom fields for a given workspace.

GET
/ beta / workspaces / {workspaceId} / custom-fields

Authorization

  • X-API-Key
    string
    required

    Header with the name X-API-Key where the value is your API key.

Path parameters

  • workspaceId
    string
    required

    The workspace for which all custom fields should be retrieved.

Response

200 - application/json - array

  • id
    string
    required

    The ID of the custom field.

  • field
    string
    required

    The type of custom field. "text", "url", "date", "person", "multiPerson", "phone", "select", "multiSelect", "number", "email", "checkbox", and "relatedTo" are all valid options.