Retornar a lista de clientes externos via API no TomTicket.
Endpoint
https://api.tomticket.com/clientes/{token}/{pagina}| Coluna | Descrição |
| token | Token de acesso único e secreto para sua empresa. Clique aqui para ver como criar. |
| pagina | Página de listagem, por padrão deve ser informado o número, são listados 50 clientes por página. |
Método
GET
Parâmetros
| Coluna | Descrição | Tipo | Tamanho Máximo |
| Parâmetros Opcionais | |||
| campos | Boolean informando se serão exibidos os campos personalizados.true - Campos serão exibidos false - Campos não serão exibidos | Boolean | - |
| coluna | Nome da coluna que será usada para realizar a ordenação. Padrão: nome | String | 20 |
Retorno
O retorno é feito no formato JSON.
| Coluna | Descrição | Tipo |
| erro | 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 |
| mensagem | Detalhes da operação, caso tenha ocorrido ou não um problema. | String |
| data | Lista com as informações dos clientes. | Array |
| data nome | Nome do cliente. | String |
| data email | Endereço de email do cliente. | String |
| data telefone | Telefone do cliente. | String |
| data id_cliente | Identificador interno do cliente. | String |
| data cota_chamados | Valor inteiro que informa o total de chamados que o cliente pode abrir ao mês, caso seja '0' então será ilimitado. | Int |
| data criacao_chamados_bloqueada | Boolean informando se o cliente está com a criação de chamados bloqueada em seu painel. | Boolean |
| data nome_organizacao | Nome da organização em que o cliente está vinculado | String |
| data campospersonalizados | Array contendo campos personalizados usados no cadastro do cliente. | Array |
| data campospersonalizados id_campo | Identificador do campo personalizado. | String |
| data campospersonalizados label | Label do campo personalizado. | String |
| data campospersonalizados valor | Valor definido para o campo no cadastro do cliente. | String |
| data email_validated | Boolean informando se o endereço de email do cliente está validado. | Boolean |
| data active | Boolean informando se o cadastro do cliente está ativo. | Boolean |
| data account_approved | Boolean informando se o cadastro do cliente está aprovado. | Boolean |