Parâmetros da requisição - Consultar Cliente - Individualmente
Campo
Tipo
Obrigatório
Tamanho máximo
Descrição
customer_id
string
Sim
250
Identificador interno do cliente para realizar a busca e atualização das informações. Pode ser o endereço de e-mail do cadastro ou o identificador interno utilizado.
customer_type_id
string
Não
1
Tipo de identificador utilizado para localizar o cliente: I - Identificador interno; E - E-mail. Valor padrão: I.
JSON de saída
JSON de saída - Consultar Cliente - Individualmente
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.
data
object
Informações do cliente.
name
string
Nome do cliente.
email
string
Endereço de e-mail do cliente.
phone
string
Telefone do cliente.
internal_id
string
Identificador interno do cliente.
monthly_ticket_quota
integer
Cota mensal de chamados que podem ser criados pelo cliente. Caso seja null, significa que é ilimitado.
active
boolean
Informa se o cliente está ativo.
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.
active
string
Informação se a organização está ativa.
monthly_ticket_quota
integer
Cota mensal de chamados da organização. Caso seja null, significa que é ilimitado.
organization_mother
array
Dados da organização matriz do cliente, caso ele esteja vinculado a uma.
id
string
Identificador da organização matriz.
name
string
Nome da organização matriz.
active
string
Informação se a organização matriz está ativa.
monthly_ticket_quota
integer
Cota mensal de chamados da organização matriz. Caso seja null, significa que é ilimitado.
permissions
array
Permissões do cliente com base no cadastro dele e herdado da organização.
active
boolean
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.
email_validated
boolean
Informa se o endereço de e-mail do cliente foi validado.
allowed_create_tickets
boolean
Informa se o cliente tem permissão para criar chamados, levando em consideração a organização e a organização matriz.
monthly_ticket_quota
boolean
Informa a cota final de chamados do cliente, levando em consideração a organização e a organização matriz.
custom_fields
array
Campos personalizados usados no cadastro do cliente.
id
string
Identificador do campo personalizado.
name
string
Label do campo personalizado.
value
null
Valor atribuído ao campo personalizado.
Possíveis erros
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.