GET
List customers

Authorizations

Authorization
string
header
required

Your API key, sent as Authorization: Bearer <key>. Create keys in the Cerium dashboard. Keep them on your servers only.

Query Parameters

email
string<email>

Only the customer with this email.

Maximum string length: 320
externalId
string

Only the customer with this externalId.

Maximum string length: 128
page
integer
default:1
Required range: x >= 1
limit
integer
default:20
Required range: 1 <= x <= 100

Response

A page of customers.

message
string
status
string
Example:

"success"

data
object[]
meta
object