GET /v1/contacts/custom-fields/catalog
GET
/v1/contacts/custom-fields/catalog
const url = 'https://seu-endereco-da-api/v1/contacts/custom-fields/catalog';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://seu-endereco-da-api/v1/contacts/custom-fields/catalog \ --header 'Authorization: Bearer <token>'Permissão que a Chave de acesso precisa: Gerenciar campos personalizados (contacts:fields), ou Ler contatos (contacts:read).
Authorizations
Seção intitulada “Authorizations”Responses
Seção intitulada “Responses”Media typeapplication/json
Array<object>
object
key
required
Chave estável, igual em todas as contas
string
label
required
string
description
required
O que o campo significa, mostrado a quem decide ligá-lo
string
type
required
string
options
required
Opções fixas da plataforma; vazio quando o tipo não usa opções
Array<string>
group
required
Campos do mesmo grupo aparecem juntos na ficha
string
enabled
required
True quando a conta ligou o campo
boolean
fieldId
required
Id do campo criado na conta, quando ligado
string
takenByOwnField
required
True quando a conta já tem um campo próprio com essa chave, o que impede ligar
boolean
sensitive
required
True quando o valor fica escondido até alguém revelar e não sai na planilha
boolean
computed
required
True quando o campo se calcula sozinho a partir das compras ou das conversas; ninguém digita o valor
boolean
Example generated
[ { "key": "example", "label": "example", "description": "example", "type": "example", "options": [ "example" ], "group": "example", "enabled": true, "fieldId": "example", "takenByOwnField": true, "sensitive": true, "computed": true }]