Listar campos personalizados

GET

/custom-fields

curl --request GET \
  --url https://dattacrm.com.br/api/v1/custom-fields \
  --header 'Authorization: Bearer <token>'

Lista os campos personalizados dos leads da conta, com chave, tipo, opções e grupo. Use a chave de cada campo em customFields ao criar ou atualizar um lead.

Authorizations

• bearerAuth

Responses

200

Sucesso.

Media type application/json

object

data

required

Campos personalizados de lead, em ordem alfabética do nome.

Array<object>

Campo personalizado de lead.

object

key

required

Chave estável do campo, usada em customFields do lead.

string

label

required

Nome do campo, como aparece na tela.

string

type

required

Tipo do campo: text, number, date, select, multi_select ou boolean.

string

Allowed values: text number date select multi_select boolean

options

required

Opções permitidas; vazio nos campos que não são de seleção.

Array<object>

Opção de um campo de seleção.

object

label

required

Texto da opção, como aparece para a pessoa.

string

value

required

Valor gravado no lead quando a opção é escolhida.

string

group

required

Grupo do campo em Leads > Campos. Todo campo tem um; o padrão é Geral.

object

id

required

Id do grupo.

string

name

required

Nome do grupo, como aparece em Leads > Campos.

string

Example

{
  "data": [
    {
      "type": "text"
    }
  ]
}

Headers

X-Request-Id

string

Identificador da requisição, para suporte.

X-RateLimit-Limit

integer

Máximo de requisições por janela de 60 segundos para esta chave.

X-RateLimit-Remaining

integer

Requisições restantes na janela atual.

X-RateLimit-Reset

integer

Fim da janela atual, em milissegundos desde a época Unix (epoch ms).

400

Dados inválidos na requisição (validation_error), lead novo sem lista (list_required), campo que mudou de lugar (field_moved) ou chave enviada na URL (api_key_in_url).

Media type application/json

Formato de erro da API.

object

error

required

object

code

required

Código estável do erro, ex.: validation_error.

string

message

required

Mensagem legível em português.

string

details

Detalhes extras, ex.: lista de campos inválidos.

requestId

required

Identificador da requisição, para suporte.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example",
    "requestId": "example"
  }
}

Headers

X-Request-Id

string

Identificador da requisição, para suporte.

401

Chave ausente, inválida (invalid_api_key), vencida (api_key_expired) ou revogada (api_key_revoked).

Media type application/json

Formato de erro da API.

object

error

required

object

code

required

Código estável do erro, ex.: validation_error.

string

message

required

Mensagem legível em português.

string

details

Detalhes extras, ex.: lista de campos inválidos.

requestId

required

Identificador da requisição, para suporte.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example",
    "requestId": "example"
  }
}

Headers

X-Request-Id

string

Identificador da requisição, para suporte.

429

Limite de requisições atingido (rate_limited). Aguarde Retry-After segundos.

Media type application/json

Formato de erro da API.

object

error

required

object

code

required

Código estável do erro, ex.: validation_error.

string

message

required

Mensagem legível em português.

string

details

Detalhes extras, ex.: lista de campos inválidos.

requestId

required

Identificador da requisição, para suporte.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example",
    "requestId": "example"
  }
}

Headers

X-Request-Id

string

Identificador da requisição, para suporte.

X-RateLimit-Limit

integer

Máximo de requisições por janela de 60 segundos para esta chave.

X-RateLimit-Remaining

integer

Requisições restantes na janela atual.

X-RateLimit-Reset

integer

Fim da janela atual, em milissegundos desde a época Unix (epoch ms).

Retry-After

integer

Segundos até poder tentar de novo.

500

Erro interno (internal_error). Informe o requestId ao suporte.

Media type application/json

Formato de erro da API.

object

error

required

object

code

required

Código estável do erro, ex.: validation_error.

string

message

required

Mensagem legível em português.

string

details

Detalhes extras, ex.: lista de campos inválidos.

requestId

required

Identificador da requisição, para suporte.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example",
    "requestId": "example"
  }
}

Headers

X-Request-Id

string

Identificador da requisição, para suporte.