Listar ou buscar contas

GET

/v1/accounts

Retorna contas do tenant autenticado. Possui dois modos de operação:

Busca por clientCode — se o parâmetro clientCode for informado, retorna diretamente a conta correspondente.

Listagem paginada — se clientCode não for informado, retorna uma lista paginada. Use filter para buscar por nome, active para filtrar por status e pageNumber/pageSize para controlar a paginação.

Requisição

Authorization

API Key

Adicionar parâmetro em header

Authorization

Exemplo:

Authorization: ********************

Parâmetros de Consulta

Respostas

🟢200

Consulta realizada com sucesso. Retorna a conta ou a lista paginada no campo data.

Esta resposta não possui corpo.

🟠401

🟠404

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v1/accounts?clientCode=undefined&filter=undefined&active=undefined&pageNumber=undefined&pageSize=undefined' \
--header 'Authorization: <api-key>'

Modificado em 2026-04-24 10:52:03

Página anterior

Criar conta

Próxima página

Buscar conta por chave