Skip to main content
GET
Get all customers

Authorizations

x-api-key
string
header
required

Query Parameters

sortOrder
enum<string>
default:desc

Case-insensitive. Values are normalized internally to ASC or DESC.

Available options:
asc,
desc
sortBy
enum<string>
default:createdAt
Available options:
createdAt,
firstName,
lastName,
emailAddress
limit
integer
default:10
Required range: 1 <= x <= 100
page
integer
default:1
Required range: x >= 1

Response

List of customers

status
enum<string>
required
Available options:
success,
error
statusCode
integer
required
message
string
required
data
object[]
required
pagination
object
required