List customers
Reference
List customers
Lists organization customers with identity, subscription, date range, tag, and segment filters.
GET
List customers
Authorizations
API key created in the organization settings.
Query Parameters
Maximum number of items per page.
Required range:
1 <= x <= 100ID of the last customer on the previous page.
Pattern:
^cus_[A-Za-z0-9_-]+$Customer's exact email address.
Customer phone number, from 3 to 32 characters.
Required string length:
3 - 32Filters customers by tag.
Pattern:
^tag_[A-Za-z0-9_-]+$Filters customers by segment.
Pattern:
^seg_[A-Za-z0-9_-]+$Filters customers by subscription status.
Includes items created at or after this instant.
Includes items created at or before this instant.
Includes customers updated at or after this instant.
Search text, up to 256 characters.
Required string length:
1 - 256Sorts by last update or total amount spent.
Available options:
updated, total_spent