Consultar Campos Personalizados - Organizações

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.

ColunaDescrição da ColunaTipo
errorInforma 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
messageDetalhes da operação, caso tenha ocorrido ou não um problema.String
successRetorna true caso a operação tenha sido concluída com sucesso.Boolean
sizeTotal de itens encontrados.Int
dataLista com os campos personalizados cadastrados.Array
data
id
Identificador do campo personalizado.String
data
label
Label de exibição do campo personalizado.String
data
mandatory
Informa se o campo personalizado é obrigatório.Boolean
data
mask
Retorna a máscara utilizada no campo, quando houver.String
data
values
Lista com os valores aceitos pelo campo personalizado.Array
data
visible_to_customer
Informa se o campo está disponível para visualização pelo cliente.Boolean
data
type
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)
Boolean

Código de Retorno

Descrição do código HTTP de retorno.

CódigoDescrição
200Operação realizada com sucesso.
401Token ou valores enviados não autorizados para uso.
403Recurso não disponível.
404Recurso não encontrado.

Disponibilidade

Recurso Premium Recurso Enterprise


Was this article helpful?  
We appreciate your review.