Skip to main content
GET
/
v1
/
custom-fields
/
{id}
Retrieve a custom field
curl --request GET \
  --url https://api4.kinbox.com.br/v1/custom-fields/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "name": "CPF",
  "type": "text",
  "isActive": true,
  "isDeleted": true,
  "invisible": true,
  "position": 123,
  "isUniqueIdentifier": true,
  "isIntegration": true,
  "showAlways": true,
  "requiredToResolve": true,
  "resetOnNewCall": true,
  "description": "Serve para identificar o contato",
  "entity": "contact",
  "placeholder": "cpf",
  "options": [
    {
      "value": "pt-BR",
      "label": "Português"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
number
required

Response

200 - application/json
​
id
string
required
​
name
string
required

Nome do campo

Example:

"CPF"

​
type
enum<string>
required

O tipo de campo que será mostrado e parseado

Available options:
text,
textarea,
number,
decimal,
select,
multi-select,
boolean,
date,
day,
datetime,
json
​
isActive
boolean
required
​
isDeleted
boolean
required
​
invisible
boolean
required

Se ativo não mostra no plugin de contato em uma conversa

​
position
number
required
​
isUniqueIdentifier
boolean
required
​
isIntegration
boolean
required

Se é um campo usado para uma integração

​
showAlways
boolean
required
​
requiredToResolve
boolean
required

Caso ativo somente permite resolver conversa se esse campo estiver ativado

​
resetOnNewCall
boolean
required

Caso ativo quando for uma nova sessão esse campo será resetado.

​
description
string

Descrição para te ajudar a saber para que serve esse campo

Example:

"Serve para identificar o contato"

​
entity
enum<string>

Descrição para te ajudar a saber para que serve esse campo

Available options:
contact,
group,
channel,
session,
user,
product,
task,
deal
​
placeholder
string

Chave que identifica esse campo em vários lugares. Geralmente é o nome em lowercase

Example:

"cpf"

​
options
object[]

Em caso de ser o tipo select ou multi-select é necessário ter as opções específicas que podem ser selecionadas