v1

latestOpenAPI 3.1.02026-07-263788129.7 KB

Schemas

Get Field Schemas for an Entity

Lists fields for entity, which must be one of accounts, contacts, meetings, opportunities, sequences, or tasks.

Use each entry's key in filters[].field and sort on the corresponding list endpoint. The allowed_operators array lists the valid values for filters[].condition on that field.

Custom fields use custom_field_{uuid} keys. Enum and select fields expose their accepted values under enum_field_settings.allowed_values, and callers must pass the key rather than the display value.

For date and datetime fields the allowed_values are semantic periods used with the is operator. The equals, greater_than, and less_than operators take raw YYYY-MM-DD values instead.

get/v1/schemas/{entity}

Path parameters

entitystring required

Response

Successful Response

Example response

{
  "data": [
    {
      "name": "Account Status",
      "key": "status",
      "type": "enum",
      "parent": "company",
      "filterable": true,
      "sortable": true,
      "allowed_operators": [
        "is",
        "is_not",
        "is_empty",
        "is_not_empty"
      ],
      "custom_field_settings": {
        "id": "cf_abc123"
      },
      "enum_field_settings": {
        "allowed_values": [
          {
            "display_value": "Active",
            "key": "active"
          }
        ]
      }
    }
  ]
}