Consultar Carteiras de Cliente

Este método permite listar todas as carteiras de clientes cadastradas em sua conta.

Endpoint

MétodoRotaContent-Type
GEThttps://api.tomticket.com/v2.0/portfolio/listform-data

Autenticação

Este endpoint utiliza autenticação Bearer Token.

Authorization: Bearer SEU_TOKEN_AQUI

Caso 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

CampoTipoDescrição
errorbooleanInforma 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.
messagestringDetalhes da operação, caso tenha ocorrido ou não um problema.
successbooleanRetorna true caso a operação tenha sido concluída com sucesso.
sizeintegerTotal de itens encontrados.
dataarrayLista com as carteiras de cliente cadastradas.
idstringIdentificador da carteira de cliente.
descriptionstringNome da carteira de clientes.

Possíveis erros

Status HTTPMensagemQuando ocorre
200Operação realizada com sucesso.Quando a requisição é processada corretamente.
401Token ou valores enviados não autorizados para uso.Quando o token ou os valores enviados não são autorizados.
403Recurso não disponível.Quando o recurso não está disponível.
404Recurso não encontrado.Quando o recurso não é encontrado.

Este artigo foi útil?  
Agradecemos sua avaliação.