Skip to main content
GET
Get All Customers

Overview

Retrieve a list of all customer accounts in your system.

Request

x-api-key
string
required
Your API key for authentication

Parameters

sortOrder
string
Sort order: asc or desc (default: desc)
sortBy
string
Field to sort by: createdAt, firstName, lastName, emailAddress (default: createdAt)
Search term to filter customers by name or email
limit
number
Number of customers to return per page (default: 10, max: 100)
page
number
Page number to retrieve (default: 1)

Response

status
string
Response status: success or error
statusCode
number
HTTP status code (200 for successful retrieval)
message
string
Human-readable response message
data
array
Array of customer objects
pagination
object

Response Example

Example

Rate Limits

  • Maximum 100 requests per minute per API key
  • Burst limit of 20 requests per second