Consultar Clientes

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.


ChaveDescriçãoObrigatórioValor PadrãoTipoTamanho Máximo
pageÍndice da página que deseja acessar. São exibidos 50 itens a cada página.Não1Int-
columnColuna usada para ordenação dos resultados.
Podem ser usadas as seguintes opções name, email, creation_date.
NãonameString20
orderMode de ordenação das colunas, podendo ser modo crescente ASC ou descrescente DESC.NãoASCString4
show_custom_fieldsDefine se os campos personalizados do cadastro do cliente serão exibidos.

Os valores disponíveis são:
0 - Não exibir
1 - Exibir
Não0Int-
organization_idPermite pesquisar clientes por um identificador de organização.Não-String512
search_by_organization_motherSe 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ão0Int-

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
pagesTotal de páginas disponíveis para consulta.Int
next_pagePróxima página disponível para navegação. Retornará NULL caso não houver.Int
previous_pagePágina anterior para navegação. Retornará NULL caso não houver.Int
dataLista com os clientes cadastrados.Array
data
id
Identificador interno do cliente.String
data
name
Nome do cliente.String
data
email
Endereço de email do cliente.String
data
phone
Telefone do cliente.String
data
monthly_ticket_quota
Cota mensal de chamados que podem ser criados pelo cliente.Int
data
allow_create_tickets
Permissão para criar chamados.Boolean
data
email_validated
Informação se o endereço de email do cliente foi validado.Boolean
data
active
Informação se o cliente está ativo.Boolean
data
account_approved
Informação se o cadastro do cliente está aprovado.Boolean
data
organization
Dados organização do cliente, caso ele esteja vinculado em uma.Array
data
organization
id
Identificador da organização.String
data
organization
name
Nome da organização.String
data
custom_fields
Campos Personalizados usados no cadastro do cliente.Array
data
custom_fields
id
Identificador do campo personalizado.String
data
custom_fields
name
Label do campo personalizado.String
data
custom_fields
value
Valor atribuído ao campo personalizado.Mixed

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.