Skip to main content
GET
List customers

Authorizations

Authorization
string
header
required

Bearer token authentication

Query Parameters

search_query
string

Filter customers with search query that matches with their email, first name, last name or external_id. Every whitespace-separated word must match, and at least one word must be 3 or more characters long.

sorted_by
string

Sort the records by one of the supported attributes:

  • id
  • email
  • 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'

has_subscription
boolean
default:false

Filter customers who have subscription

has_recent_orders
boolean
default:false

Filter customers who have recent orders made within last 30 days

has_failed_orders
boolean
default:false

Filter customers who have failed orders

purchased_more_than_once
boolean
default:false

Filter customers who have purchased more than once

us_customers
boolean
default:false

Filter customers from US

non_us_customers
boolean
default:false

Filter customers outside from US

abandoned_in_the_last_30_days
boolean
default:false

Filter customers who have abandoned cart within last 30 days

reps
boolean
default:false

Filter customers who are also Reps

order_status
enum<string>

Filter customers by their order status

Available options:
fulfilled,
unfulfilled
ordered_since
string

Filter customers who have ordered since the specified date. Can be used for e.g. last 30 days, 90 days, etc.

location
string

Filter customers based upon their default address country iso. US, CA, UK, etc.

subscription_status
enum<string>

Filter customers by their subscription orders status. active or inactive

Available options:
active,
inactive
created_between
string

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.

with_total_orders_between
string

Filter customers by total number of orders range. Format: min-max. Example: '2-5', '2-', '-5'

with_total_spent_between
string

Filter customers by total amount spent range. Format: min-max. Example: '200-500', '200-', '-500'

active_subscription_amount_between
string

Filter customers by total amount of active subscription orders (e.g. '100-500' or '100-' or '-500')

inactive_subscription_amount_between
string

Filter customers by total amount of inactive subscription orders (e.g. '100-500' or '100-' or '-500')

for_rep
integer

Filter customers by their rep id (user_company_id)

page
integer
default:1

Page number for pagination. When search_query is set, the page may not start past row 10,000.

per_page
integer
default:10

Number of records per page

Required range: 1 <= x <= 1000
include_total
boolean

When true, meta.total_count and meta.total_pages contain the total; when false, both fields are zero. Defaults to false when search_query is sent and true otherwise. Counting every match is expensive on large companies, so leave it off unless you display a page count. meta.next_page is always present and is null on the last page.

by_metadata
string<json>
default:{}

Search JSON meta data

Response

object | null

Success

customers
(object | null)[] | null
meta
object | null