Synup
Create a key
v1Resources/Custom Fields/getList custom field definitions

List custom field definitions

Returns the custom-field schema defined for the given entity type (location or client), ordered the way they display in the UI.

get/api/v1/custom-fields/definitions
custom-fields:read
Query parameters
entityTypestring (location | client)required
Which entity type's schema to list: "location" or "client".
Response
dataarray of objectoptional
idstringoptional
Unique identifier for the custom field definition.
entityTypestring (location | client)optional
The entity type this definition applies to: "location" or "client".
keystringoptional
Immutable slug identifying this field, derived from its label at creation. Use this to reference the field when setting values.
labelstringoptional
The custom field's display label.
typestring (text | number | date | single_select | multi_select)optional
The field's value type.
requiredbooleanoptional
Whether the field is marked required. This isn't enforced by the API — it's a UI hint only.
optionsarray of stringoptional
The field's selectable options, for single_select and multi_select fields. Null for other types.
createdBystringoptional
Who created this field definition: "user" or "agent".
ordernumberoptional
The field's display order relative to other definitions for the same entity type, lowest first.
Errors
400The request is missing a required parameter or is otherwise malformed.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
429Too many requests. Retry after the number of seconds in the Retry-After header.
get/api/v1/custom-fields/definitions
Your API key
entityType *
{
  "data": [
    {
      "id": "cm_def_abc123",
      "entityType": "location",
      "key": "parking_notes",
      "label": "Parking notes",
      "type": "text",
      "required": false,
      "options": null,
      "createdBy": "user",
      "order": 0
    }
  ]
}