Skip to main content
GET
List Customers

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
number
default:1
Required range: x >= 1
limit
number
default:10
Required range: 1 <= x <= 100

Free-text search across customer name, email and document.

document_number
string

Filter by exact customer document number.

email
string

Filter customers by exact email address.

phone
string

Filter customers by phone number.

external_ref
string

Filter customers by your external reference.

status
string

Filter customers by current status.

ip_address
string

Filter customers by last known IP address.

Response

Success

success
boolean
required
requestId
string
required
metadata
object
required
data
object[]
required