Skip to main content
GET
Get all customers

Overview

Retrieve a merchant-scoped, paginated list of customers. Results are ordered by the selected field and direction.

Request

string
required
Your API key for authentication

Parameters

string
Sort direction: asc or desc (default: desc). Values are case-insensitive.
string
Field to sort by: createdAt, firstName, lastName, emailAddress (default: createdAt)
Search term to filter customers by name or email
number
Number of customers to return per page (default: 10, max: 100)
number
Page number to retrieve (default: 1)

Response

string
Response status: success or error
number
HTTP status code (200 for successful retrieval)
string
Human-readable response message
object
Contains result, an array of customer objects, and pagination, the page metadata.

Response Example

Example

Errors

Results are scoped to the merchant associated with x-api-key. An empty result array is a successful response.

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