Este método permite listar todos os seus clientes.
A consulta de clientes exibe 50 itens por página, sendo necessário navegar entre as páginas para consultar outros resultados.
Endpoint
https://api.tomticket.com/v2.0/customer/list
Método HTTP
GET
Content Type
form-data
Autenticação
Authorization: Bearer {SEU-TOKEN-AQUI}
Parâmetros Query String
Os parâmetros Query String são enviadas diretamente na URL após o símbolo de "?" ao final do endpoint. Cada parâmetro e valor deve ser enviado com o nome dele e valor, separados pelo símbolo de "=", como por exemplo nomeParametro=ValorParametro. Para enviar mais de um parâmetro, deve separá-los, usando símbolo "&", como por exemplo nomeParametro1=ValorParametro1&nomeParametro2=ValorParametro2.
| Chave | Descrição | Obrigatório | Valor Padrão | Tipo | Tamanho Máximo |
|---|---|---|---|---|---|
| page | Índice da página que deseja acessar. São exibidos 50 itens a cada página. | Não | 1 | Int | - |
| column | Coluna usada para ordenação dos resultados. Podem ser usadas as seguintes opções name, email, creation_date. | Não | name | String | 20 |
| order | Mode de ordenação das colunas, podendo ser modo crescente ASC ou descrescente DESC. | Não | ASC | String | 4 |
| show_custom_fields | Define se os campos personalizados do cadastro do cliente serão exibidos. Os valores disponíveis são: 0 - Não exibir 1 - Exibir | Não | 0 | Int | - |
| organization_id | Permite pesquisar clientes por um identificador de organização. | Não | - | String | 512 |
| search_by_organization_mother | Se informado o parâmetro organization_id define se irá realizar a busca pela organização matriz também. Os valores disponíveis são: 0 - Não pesquisar pela matriz da organização 1 - Pesquisar pela matriz da organização | Não | 0 | Int | - |
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 |
| pages | Total de páginas disponíveis para consulta. | Int |
| next_page | Próxima página disponível para navegação. Retornará NULL caso não houver. | Int |
| previous_page | Página anterior para navegação. Retornará NULL caso não houver. | Int |
| data | Lista com os clientes cadastrados. | Array |
| dataid | Identificador interno do cliente. | String |
| dataname | Nome do cliente. | String |
| dataemail | Endereço de email do cliente. | String |
| dataphone | Telefone do cliente. | String |
| datamonthly_ticket_quota | Cota mensal de chamados que podem ser criados pelo cliente. | Int |
| dataallow_create_tickets | Permissão para criar chamados. | Boolean |
| dataemail_validated | Informação se o endereço de email do cliente foi validado. | Boolean |
| dataactive | Informação se o cliente está ativo. | Boolean |
| dataaccount_approved | Informação se o cadastro do cliente está aprovado. | Boolean |
| dataorganization | Dados organização do cliente, caso ele esteja vinculado em uma. | Array |
| dataorganization id | Identificador da organização. | String |
| dataorganization name | Nome da organização. | String |
| datacustom_fields | Campos Personalizados usados no cadastro do cliente. | Array |
| datacustom_fields id | Identificador do campo personalizado. | String |
| datacustom_fields name | Label do campo personalizado. | String |
| datacustom_fields value | Valor atribuído ao campo personalizado. | Mixed |
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
