Consultar Cliente - Individualmente

Este método permite consultar os detalhes de um cliente.


Endpoint

https://api.tomticket.com/v2.0/customer/details


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
customer_idIdentificador interno do cliente para realizar a busca e atualização das informações. Pode ser o endereço de email do cadastro ou identificador interno utilizado.
Sim-String250
customer_type_id
Tipo de identificador utilizado para localizar o cliente, sendo:
I - Identificador interno
E - Email
Não
I
String
1

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
dataInformações do cliente.
Object
data
name
Nome do cliente.String
data
email
Endereço de email do cliente.String
data
phone
Telefone do cliente.String
data
internal_id
Identificador interno do cliente.String
data
monthly_ticket_quota
Cota mensal de chamados que podem ser criados pelo cliente. . Caso seja NULL, significa que é ilimitado.Int
data
active
Informação se o cliente está ativo.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
organization
    active
Informação se a organização está ativa.String
data
organization
    monthly_ticket_quota
Cota mensal de chamados da organização. Caso seja NULL, significa que é ilimitado.Int
data
organization_mother
Dados organização matriz do cliente, caso ele esteja vinculado em uma.Array
data
organization_mother
    id
Identificador da organização matriz.String
data
organization_mother
    name
Nome da organização matriz.String
data
organization_mother
    active
Informação se a organização matriz está ativa.String
data
organization_mother
    monthly_ticket_quota
Cota mensal de chamados da organização matriz. Caso seja NULL, significa que é ilimitado.Int
data
permissions
Permissões do cliente com base no cadastro dele e herdado da organização.Array
data
permissions
    active
Retorna se o cliente está ativo ou não, levando em consideração que, caso a organização dele ou a organização matriz estejam inativas, o mesmo estará inativo.Boolean
data
permissions
    email_validated
Informação se o endereço de email do cliente foi validado.Boolean
data
permissions
    allowed_create_tickets
Informa se o cliente ter permissão para criar chamados, levando em consideração a organização e a organização matriz.Boolean
data
permissions
    monthly_ticket_quota
Informa a cota final de chamados do cliente, levando em consideração a organização e a organização matriz.Boolean
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.