List customers
Get all customers with optional filters
Authorizations
Bearer token authentication
Query Parameters
Filter customers with search query that matches with their email, first name, last name or external_id
Sort the records by one of the supported attributes:
- id
- created_at
- updated_at
- country
- full_name
- active_subscriptions_count
- inactive_subscriptions_count
- orders_count
- last_ordered_at
The sort attribute should be followed by one of the order directives: '_asc', '_desc'
Filter customers who have subscription
Filter customers who have recent orders made within last 30 days
Filter customers who have failed orders
Filter customers who have purchased more than once
Filter customers from US
Filter customers outside from US
Filter customers who have abandoned cart within last 30 days
Filter customers who are also Reps
Filter customers by their order status
fulfilled, unfulfilled Filter customers who have ordered since the specified date. Can be used for e.g. last 30 days, 90 days, etc.
Filter customers based upon their default address country iso. US, CA, UK, etc.
Filter customers by their subscription orders status. active or inactive
active, inactive Filter customers by creation date range. Format: MM-DD-YYYY-MM-DD-YYYY. Examples: '01-01-2024-12-31-2024' (between dates), '01-01-2024-' (after date), '-12-31-2024' (before date). Note: URL-encode the entire parameter value.
Filter customers by total number of orders range. Format: min-max. Example: '2-5', '2-', '-5'
Filter customers by total amount spent range. Format: min-max. Example: '200-500', '200-', '-500'
Filter customers by total amount of active subscription orders (e.g. '100-500' or '100-' or '-500')
Filter customers by total amount of inactive subscription orders (e.g. '100-500' or '100-' or '-500')
Filter customers by their rep id (user_company_id)
Page number for pagination
Number of records per page
Search JSON meta data