Este método permite listar todas as carteiras de clientes cadastradas em sua conta.
Endpoint
| Método | Rota | Content-Type |
|---|---|---|
GET | https://api.tomticket.com/v2.0/portfolio/list | form-data |
Autenticação
Este endpoint utiliza autenticação Bearer Token.
Authorization: Bearer SEU_TOKEN_AQUICaso ainda não possua um Token de Acesso, consulte o artigo Criação do Token de Acesso.
JSON de saída
JSON de saída - Consultar Carteiras de Cliente
| Campo | Tipo | Descrição |
|---|---|---|
error | boolean | 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. |
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. |
data | array | Lista com as carteiras de cliente cadastradas. |
id | string | Identificador da carteira de cliente. |
description | string | Nome da carteira de clientes. |
Possíveis erros
| Status HTTP | Mensagem | Quando ocorre |
|---|---|---|
200 | Operação realizada com sucesso. | Quando a requisição é processada corretamente. |
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 está disponível. |
404 | Recurso não encontrado. | Quando o recurso não é encontrado. |