v1

latestOpenAPI 3.1.02026-07-24172151607.6 KB
Custom Fields

Get List Custom Fields

View the Custom Fields you have access to in a specific List.

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 List.

get/v2/list/{list_id}/field

Path parameters

list_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

Example response

{
  "fields": [
    {
      "id": "03efda77-c7a0-42d3-8afd-fd546353c2f5",
      "name": "Text Field",
      "type": "text",
      "type_config": {},
      "date_created": "1566400407303",
      "hide_from_guests": false
    }
  ]
}