Este método permite listar todos os campos personalizados de sua conta.
Endpoint
| Método | Rota | Content-Type |
|---|---|---|
GET | https://api.tomticket.com/v2.0/custom_field/general/list | form-data |
Autenticação
Este endpoint utiliza autenticação Bearer Token.
Authorization: Bearer SEU_TOKEN_AQUICaso ainda não possua um Token de Acesso, consulte o artigo Criação do Token de Acesso.
JSON de saída
JSON de saída - Consultar Campos Personalizados - Todos
| Campo | Tipo | Descrição |
|---|---|---|
error | boolean | 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. |
message | string | Detalhes da operação, caso tenha ocorrido ou não um problema. |
success | boolean | Retorna true caso a operação tenha sido concluída com sucesso. |
size | integer | Total de itens encontrados. |
data | array | Lista com os campos personalizados cadastrados. |
id | string | Identificador do campo personalizado. |
label | string | Label de exibição do campo personalizado. |
mandatory | boolean | Informa se o campo personalizado é obrigatório. |
mask | string | Retorna a máscara utilizada no campo, quando houver. |
values | array | Lista com os valores aceitos pelo campo personalizado. |
visible_to_customer | boolean | Informa se o campo está disponível para visualização pelo cliente. |
type | boolean | Informa o tipo do campo. Opções disponíveis: 1 - Campo de Texto; 2 - Área de Texto; 3 - Caixa de Opções (Input=Select, ComboBox); 4 - Opções (Input=Radio, Ragio Group); 5 - Caixa de Verificação (Checkbox); 6 - Seleção Múltipla (Listbox). |
Possíveis erros
| Status HTTP | Mensagem | Quando ocorre |
|---|---|---|
| 401 | Token ou valores enviados não autorizados para uso. | Quando o token ou os valores enviados não são autorizados. |
| 403 | Recurso não disponível. | Quando o recurso não está disponível. |
| 404 | Recurso não encontrado. | Quando o recurso não é encontrado. |