Consultar Clientes

Recurso Premium Recurso Enterprise

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

Método	Rota	Content-Type
`GET`	`https://api.tomticket.com/v2.0/customer/list`	`form-data`

Este endpoint utiliza autenticação Bearer Token.

Authorization: Bearer SEU_TOKEN_AQUI

Caso ainda não possua um Token de Acesso, consulte o artigo Criação do Token de Acesso.

Campo	Tipo	Obrigatório	Tamanho máximo	Descrição
`page`	integer	Não	-	Índice da página que deseja acessar. São exibidos 50 itens a cada página.
`column`	string	Não	20	Coluna usada para ordenação dos resultados. Podem ser usadas as opções name, email e creation_date.
`order`	string	Não	4	Modo de ordenação das colunas, podendo ser crescente ASC ou decrescente DESC.
`show_custom_fields`	integer	Não	-	Define se os campos personalizados do cadastro do cliente serão exibidos. Valores disponíveis: 0 para não exibir e 1 para exibir.
`organization_id`	string	Não	512	Permite pesquisar clientes por um identificador de organização.
`search_by_organization_mother`	integer	Não	-	Se informado o parâmetro organization_id, define se a busca também será realizada pela organização matriz. Valores disponíveis: 0 para não pesquisar pela matriz e 1 para pesquisar pela matriz.

Campo	Tipo	Descrição
`error`	boolean	Informa se ocorreu um erro na operação.
`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.
`pages`	integer	Total de páginas disponíveis para consulta.
`next_page`	integer	Próxima página disponível para navegação. Retornará null caso não haja.
`previous_page`	integer	Página anterior para navegação. Retornará null caso não haja.
`data`	array	Lista com os clientes cadastrados.
`id`	string	Identificador interno do cliente.
`name`	string	Nome do cliente.
`email`	string	Endereço de e-mail do cliente.
`phone`	string	Telefone do cliente.
`monthly_ticket_quota`	integer	Cota mensal de chamados que podem ser criados pelo cliente.
`allow_create_tickets`	boolean	Permissão para criar chamados.
`email_validated`	boolean	Informação se o endereço de e-mail do cliente foi validado.
`active`	boolean	Informação se o cliente está ativo.
`account_approved`	boolean	Informação se o cadastro do cliente está aprovado.
`organization`	array	Dados da organização do cliente, caso ele esteja vinculado a uma.
`id`	string	Identificador da organização.
`name`	string	Nome da organização.
`custom_fields`	array	Campos personalizados usados no cadastro do cliente.
`id`	string	Identificador do campo personalizado.
`name`	string	Label do campo personalizado.
`value`	mixed	Valor atribuído ao campo personalizado.

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 estiver disponível.
404	Recurso não encontrado.	Quando o recurso não é encontrado.
200	Operação realizada com sucesso.	Quando a operação é concluída com sucesso.