List customers

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Overview

Retrieve a paginated list of customers on your site. Supports filtering and sorting and expanding relationships.

Example: You want to find all customers from a specific company. Call this endpoint with filter[metadata.company]=eq:Acme to get the list.

FeatureFields
Searchableemail, first_name, last_name, id, metadata.*
Sortableid, email
Expandableaddresses, defaultSource, organization, subscriptions
Query Params
int32
required
int32
Defaults to 10
int32
Defaults to 1
string
enum
Allowed:
string
string
string
string
string
string
string
Headers
string
required
Defaults to Bearer eyJ***
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json