Skip to main content
GET
List customers
Returns a page of customers for your company. Each item uses the same shape as Get Customer, so every customer carries its additionalData field map and subscriptionStatus entries.
limit caps at 100 per page. When you are syncing additional data fields for a large audience, page through with sort=updatedAt:desc and stop once you reach records you already have.

Authorizations

x-api-key
string
header
required

API key for authentication. Create one in Settings > Developer.

Query Parameters

page
integer
default:1

Page number

Required range: x >= 1
limit
integer
default:20

Number of results per page

Required range: 1 <= x <= 100

Search by name, email, or phone number

source
string

Filter by source values (comma-separated)

tags
string

Filter by tags (comma-separated)

sort
string
default:updatedAt:desc

Sort field and direction (e.g., updatedAt:desc)

Response

Successful response

data
object[]
meta
object