List customers

Retrieve a paginated list of customers with support for filtering, sorting, and relationship expansion.

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

Related Endpoints

Language
Credentials
Click Try It! to start a request and see the response here!