Skip to main content
GET
Listar clientes
Retorna uma lista paginada de clientes com opções de filtragem.

Autorizações

Authorization
string
header
obrigatório

Token JWT obtido via /v1/auth/token

Parâmetros de consulta

page
integer
padrão:1

Numero da pagina

Exemplo:

1

pageSize
integer
padrão:20

Itens por pagina (max: 100)

Exemplo:

20

status
enum<string>

Filtrar por status

Opções disponíveis:
Active,
Inactive
Exemplo:

"Active"

documentType
enum<string>

Filtrar por tipo de documento

Opções disponíveis:
CPF,
CNPJ
Exemplo:

"CPF"

Buscar por nome, email ou documento

Exemplo:

"joao"

externalId
string

Filtrar por ID externo

Exemplo:

"cliente_123"

Resposta

Lista de clientes

data
object | null
message
string | null
error
object | null