Campos Personalizados
List Custom Fields
API
Ambiente
- Contatos
- Campos Personalizados
- Conversas
- Tags
- Produtos
- Negócios
- Campanhas
- Dashboards
Campos Personalizados
List Custom Fields
Listar todos os campos personalizados
GET
/
v3
/
custom-fields
curl --request GET \
--url https://api4.kinbox.com.br/v3/custom-fields \
--header 'Authorization: Bearer <token>'
{
"totalCount": 123,
"data": [
{
"id": "<string>",
"_id": "<string>",
"name": "<string>",
"description": "<string>",
"entity": "<string>",
"placeholder": "<string>",
"type": "<string>",
"options": {},
"isActive": true,
"isDeleted": true,
"invisible": true,
"position": 123,
"isUniqueIdentifier": true,
"isIntegration": true,
"showAlways": true,
"requiredToResolve": true,
"resetOnNewCall": true,
"validate": {},
"validation_mask": {},
"validation_type": "<string>",
"dependency": {},
"isDependent": true,
"workspaceId": 123,
"createdAt": "2023-11-07T05:31:56Z",
"lastUpdateAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Response
200 - application/json
Total de registros
curl --request GET \
--url https://api4.kinbox.com.br/v3/custom-fields \
--header 'Authorization: Bearer <token>'
{
"totalCount": 123,
"data": [
{
"id": "<string>",
"_id": "<string>",
"name": "<string>",
"description": "<string>",
"entity": "<string>",
"placeholder": "<string>",
"type": "<string>",
"options": {},
"isActive": true,
"isDeleted": true,
"invisible": true,
"position": 123,
"isUniqueIdentifier": true,
"isIntegration": true,
"showAlways": true,
"requiredToResolve": true,
"resetOnNewCall": true,
"validate": {},
"validation_mask": {},
"validation_type": "<string>",
"dependency": {},
"isDependent": true,
"workspaceId": 123,
"createdAt": "2023-11-07T05:31:56Z",
"lastUpdateAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}