Skip to main content
GET
Listar clientes
Returns a paginated list of customers for the authenticated merchant.

Authorizations

Authorization
string
header
required

Token JWT obtido via /v1/auth/token

Query Parameters

page
integer
default:1

Numero da pagina

Example:

1

pageSize
integer
default:20

Itens por pagina (max: 100)

Example:

20

status
enum<string>

Filtrar por status

Available options:
Active,
Inactive
Example:

"Active"

documentType
enum<string>

Filtrar por tipo de documento

Available options:
CPF,
CNPJ
Example:

"CPF"

Buscar por nome, email ou documento

Example:

"joao"

externalId
string

Filtrar por ID externo

Example:

"cliente_123"

Response

Lista de clientes

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