get
https://{subdomain}.kommo.com/api/v4/catalogs//custom_fields/
Este método permite obter uma lista de campos personalizados na conta.
Limitações
O método está disponível para todos os usuários da conta.
Cabeçalho de tipo de dado quando a solicitação é bem-sucedida
Content-Type: application/hal+json
Cabeçalho de tipo de dado em caso de erro
Content-Type: application/problem+json
Parâmetros de resposta
O método retorna um array de modelos de campos personalizados. As propriedades do objeto de campo personalizado estão listadas abaixo. As propriedades do objeto variam dependendo da entidade.
| Parametro | Tipo de dado | Descrição |
|---|---|---|
| id | int | ID do campo |
| name | string | Nome do campo |
| code | string | Código do campo que pode ser usado para atualizar o valor sem passar o ID do campo na solicitação. |
| sort | int | Ordenação do campo |
| type | int | Tipo de campo |
| entity_type | string | Tipo de campo (leads, contatos, empresas) |
| enums | array|null | Array de valores disponíveis para campos com valores enumerados. |
| enums[0] | object | Modelo de valor disponível. |
| enums[id] | int | ID do valor |
| enums[value] | string | Valor |
| enums[sort] | int | Ordenação dos valores. |