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.
| Chave | Descrição | Obrigatório | Valor Padrão | Tipo | Tamanho Máximo |
|---|---|---|---|---|---|
| customer_id | Identificador 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 | - | String | 250 |
| 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.
| 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 |
| data | Informações do cliente. | Object |
| dataname | Nome do cliente. | String |
| dataemail | Endereço de email do cliente. | String |
| dataphone | Telefone do cliente. | String |
| datainternal_id | Identificador interno do cliente. | String |
| datamonthly_ticket_quota | Cota mensal de chamados que podem ser criados pelo cliente. . Caso seja NULL, significa que é ilimitado. | Int |
| dataactive | Informação se o cliente está ativo. | 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 |
| dataorganization active | Informação se a organização está ativa. | String |
| dataorganization monthly_ticket_quota | Cota mensal de chamados da organização. Caso seja NULL, significa que é ilimitado. | Int |
| dataorganization_mother | Dados organização matriz do cliente, caso ele esteja vinculado em uma. | Array |
| dataorganization_mother id | Identificador da organização matriz. | String |
| dataorganization_mother name | Nome da organização matriz. | String |
| dataorganization_mother active | Informação se a organização matriz está ativa. | String |
| dataorganization_mother monthly_ticket_quota | Cota mensal de chamados da organização matriz. Caso seja NULL, significa que é ilimitado. | Int |
| datapermissions | Permissões do cliente com base no cadastro dele e herdado da organização. | Array |
| datapermissions 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 |
| datapermissions email_validated | Informação se o endereço de email do cliente foi validado. | Boolean |
| datapermissions 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 |
| datapermissions monthly_ticket_quota | Informa a cota final de chamados do cliente, levando em consideração a organização e a organização matriz. | Boolean |
| 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
