Sign in

v1

latestOpenAPI 3.1.02026-07-26549156879.0 KB
CustomFields > Field

Reads all Fields

Reads all Fields

get/api/2026-07-01/resources/custom_fields/fields

Query parameters

ids[]string[]

Field identifiers

Field identifiers

[
  "1",
  "2"
]
field_type'text' | 'long_text' | 'date' | 'rating' | 'checkbox' | 'single_choice' | 'multiple_choice' | 'money' | 'cents'

Filter fields by type

Example:text

Filter fields by type

labelstring

Field label

Example:T-Shirt Size

Field label

slugstring

Custom field slug

Example:tshirt_size

Custom field slug

company_idstring

Company identifier where this field belongs

Example:3

Company identifier where this field belongs

Response

OK

Example response

{
  "data": [
    {
      "id": "2",
      "field_type": "text",
      "label_text": "T-Shirt Size",
      "position": 3,
      "required": true,
      "min_value": 10,
      "legal_entity_name": "Factorial Legal",
      "legal_entity_id": "1",
      "slug": "tshirt_size"
    }
  ]
}