Referência
Campos personalizados
Dicionário das chaves que aparecem dentro de `custom_fields` nas outras fichas: o que cada chave significa, de que tipo é e quais valores aceita.
GET {BASE_URL}/api-v1/custom-fields # lista
GET {BASE_URL}/api-v1/custom-fields/:id # detalheEste recurso ainda não está no ar. Ele existe só no endereço novo
({BASE_URL}/api-v1/custom-fields), que ainda não foi publicado: hoje qualquer chamada para ele
devolve 404 not_found. Esta página existe para você já preparar a
integração — avisaremos aqui quando o endereço entrar no ar.
Escopo: catalogos:read (somente leitura).
Campos
| Campo | Tipo | Notas |
|---|---|---|
id | uuid | |
entity | string | A que ficha a definição pertence (deal, contact, company). |
key | string | É esta a chave usada dentro do objeto custom_fields. |
label | string | |
type | string | |
options | objeto | Valores aceitos quando o tipo é de escolha. |
required | boolean | |
position | number | |
created_at | datetime |
Listar campos personalizados
GET {BASE_URL}/api-v1/custom-fields
| Parâmetro (query) | Tipo | Notas |
|---|---|---|
entity | string | |
limit | number | Tamanho da página. Padrão 50, máximo 200. |
cursor | uuid | Próxima página — use o meta.next_cursor da resposta anterior. |
Ordenação: id crescente. Paginação por cursor.
curl "{BASE_URL}/api-v1/custom-fields?entity=..." \
-H "X-API-Key: vnd_sua_chave_aqui"{
"data": [ /* registros */ ],
"meta": { "next_cursor": "8f3c...", "has_more": true }
}Consultar um registro
GET {BASE_URL}/api-v1/custom-fields/:id → o recurso completo, ou 404 not_found.
curl "{BASE_URL}/api-v1/custom-fields/8f3c..." \
-H "X-API-Key: vnd_sua_chave_aqui"Erros
| HTTP | code | Quando |
|---|---|---|
401 | missing_api_key / invalid_api_key / revoked_api_key | Autenticação. |
403 | insufficient_scope | A chave não tem catalogos:read. |
404 | not_found | O registro não existe neste cliente. |
422 | invalid_cursor | O cursor enviado não é válido. |
405 | method_not_allowed | Método não suportado neste endereço. |
500 | internal_error | Falha interna. |
Catálogo completo em Erros.