Skip to main content
GET
List customers

Authorizations

X-API-Key
string
header
required

Company API key. Send in the X-API-Key header.

Headers

x-client-id
string
required

Client identifier for the company in the request.

Example:

"client_abc123"

Query Parameters

name
string

Partial name search

Example:

"John"

email
string

Partial email search

Example:

"john@"

token
string

Exact customer vault token

Example:

"cus_abc123"

document
string

CPF or CNPJ (digits only or formatted)

Example:

"12345678909"

phone
string

Partial phone search (digits only or formatted)

Example:

"31994878998"

per_page
integer
Example:

15

page
integer
Example:

1

Response

Paginated list of customers

data
object[]
meta
object