Synupv1
Criar chave
v1Recursos/Custom Fields/getListar definições de campos personalizados

Listar definições de campos personalizados

Retorna o esquema de campos personalizados definido para o tipo de entidade informado (location ou client), na ordem em que são exibidos na interface.

get/api/v1/custom-fields/definitions
custom-fields:read
Parâmetros de consulta
entityTypestring (location | client)obrigatório
Qual tipo de entidade listar o esquema: "location" ou "client".
Resposta
dataarray of objectopcional
idstringopcional
Identificador único da definição de campo personalizado.
entityTypestring (location | client)opcional
O tipo de entidade ao qual esta definição se aplica: "location" ou "client".
keystringopcional
Slug imutável identificando este campo, derivado do seu label na criação. Use isto para referenciar o campo ao definir valores.
labelstringopcional
O rótulo de exibição do campo personalizado.
typestring (text | number | date | single_select | multi_select)opcional
O tipo de valor do campo.
requiredbooleanopcional
Se o campo está marcado como required. Isto não é aplicado pela API — é apenas uma dica para a interface.
optionsarray of stringopcional
As opções selecionáveis do campo, para campos single_select e multi_select. Null para outros tipos.
createdBystringopcional
Quem criou esta definição de campo: "user" ou "agent".
ordernumberopcional
A ordem de exibição do campo em relação a outras definições do mesmo tipo de entidade, a menor primeiro.
Erros
400Falta um parâmetro obrigatório na solicitação, ou ela é inválida de outra forma.
401Chave de API ausente, inválida, expirada ou revogada.
403A chave não tem a permissão exigida, ou não está autorizada para este cliente/local.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
get/api/v1/custom-fields/definitions
Sua chave de API
entityType *
{
  "data": [
    {
      "id": "cm_def_abc123",
      "entityType": "location",
      "key": "parking_notes",
      "label": "Parking notes",
      "type": "text",
      "required": false,
      "options": null,
      "createdBy": "user",
      "order": 0
    }
  ]
}