Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Retorna todos os campos personalizados da organização.
GET /v1/custom-fields
read:custom_fields
| Parâmetro | Tipo | Descrição |
|---|---|---|
entity | string | Filtra por entidade: contact, company, deal |
curl "https://api.socialsell.ai/v1/custom-fields?entity=contact" \
-H "Authorization: Bearer sk_live_..."
{
"data": [
{
"id": "6646c52790822ff5f59c68cb",
"key": "cpf",
"label": "CPF",
"type": "text",
"entity": "contact",
"options": null,
"default_value": null,
"required": false,
"is_active": true,
"created_at": "2026-03-02T10:00:00.000Z",
"updated_at": "2026-03-02T10:00:00.000Z"
}
],
"meta": { "total": 1, "has_more": false }
}
| Campo | Tipo | Descrição |
|---|---|---|
id | string | ID do campo |
key | string | Chave única (imutável após criação) |
label | string | Rótulo de exibição |
type | string | Tipo do campo |
entity | string | Entidade: contact, company ou deal |
options | array | null | Opções para select/multiselect. Vem null, não [], quando não há opções |
default_value | any | Valor padrão |
required | boolean | Se é obrigatório |
is_active | boolean | Se está ativo |
created_at | string | Criação |
updated_at | string | Última atualização |
custom_fields (chave → valor) em contatos, empresas e negócios.| Código | Status | Descrição |
|---|---|---|
INTERNAL_ERROR | 500 | Falha interna ao processar a requisição |