Skip to main content
GET
List Customers

Overview

Retrieve a paginated list of customers belonging to the authenticated merchant. Supports filtering by email.

Authentication

string
required
Your merchant API key

Query Parameters

integer
Results per pageDefault: 50 | Max: 200
integer
Page number to retrieveDefault: 1
string
Filter by exact email addressExample: customer@example.com

Request Example

Response

array
required
Array of customer objects
integer
required
Current page number
integer
required
Results per page
integer
required
Total number of customers matching the query
integer
required
Total number of pages available

Success Response

Pagination

This endpoint uses page-based pagination.
  1. Make your initial request (optionally with limit and page)
  2. Check total_pages to determine how many pages are available
  3. Increment page to fetch subsequent pages until you reach total_pages