Skip to main content
GET
/
api
/
v1
/
customers
List customers
curl --request GET \
  --url http://localhost:7701/api/v1/customers \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {}
  ],
  "meta": {
    "current_page": 1,
    "per_page": 15,
    "total": 42,
    "last_page": 3
  }
}

Authorizations

​
X-API-Key
string
header
required

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

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