Este método permite listar todos os campos personalizados de sua conta usados para cadastro de organizações.
Endpoint
https://api.tomticket.com/v2.0/custom_field/organization/list
Método HTTP
GET
Content Type
form-data
Autenticação
Authorization: Bearer {SEU-TOKEN-AQUI}
Retorno
Descrição do retorno em JSON.
Coluna | Descrição da Coluna | Tipo |
---|---|---|
error | Informa se ocorreu um erro na operação. Se o retorno for false, então significa que a operação ocorreu com sucesso e não ocorreram problemas. Caso o retorno seja true, ocorreu um erro e será necessário verificar o campo mensagem para identificar o problema. | Boolean |
message | Detalhes da operação, caso tenha ocorrido ou não um problema. | String |
success | Retorna true caso a operação tenha sido concluída com sucesso. | Boolean |
size | Total de itens encontrados. | Int |
data | Lista com os campos personalizados cadastrados. | Array |
| Identificador do campo personalizado. | String |
| Label de exibição do campo personalizado. | String |
| Informa se o campo personalizado é obrigatório. | Boolean |
| Retorna a máscara utilizada no campo, quando houver. | String |
| Lista com os valores aceitos pelo campo personalizado. | Array |
| Informa se o campo está disponível para visualização pelo cliente. | Boolean |
| Informa o tipo do campo. Opções Disponíveis:
| Boolean |
Código de Retorno
Descrição do código HTTP de retorno.
Código | Descrição |
---|---|
200 | Operação realizada com sucesso. |
401 | Token ou valores enviados não autorizados para uso. |
403 | Recurso não disponível. |
404 | Recurso não encontrado. |
Disponibilidade