List subscribers
List subscribers
Overview
List subscribers
Request parameters
cursorstringquery
Opaque cursor from the previous response. Omit for the first page.
limitnumberquery
Items per page. Default: 50. Maximum: 200.
searchstringquery
Partial text search across subscriber ID, name, email, and related subscription fields.
Request body
No request body.
Request examples
No request body.
Responses
has_morebooleanRequiredTrue if more items are available after this page.
cursorstringRequiredPass this as cursor to fetch the next page. Null when has_more is false.
itemsSubscriber[]RequiredArray (Subscriber):
idstringSubscriber ID.
first_namestringlast_namestringfull_namestringemailstringlatest_countrystringISO country code of the subscriber's latest order's shipping address.
latest_order_datedateDate of the subscriber's latest order.
has_active_subscriptionbooleanWhether the subscriber has an active subscription or membership.
subscription_countnumberNumber of subscriptions or memberships the subscriber has purchased.
ltvstringLifetime value (account currency).
ltv_currencystringISO currency code for ltv (account selling currency).
date_createddateExample
{
"has_more": "<boolean>",
"cursor": "<string>",
"items": [
{
"id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"full_name": "<string>",
"email": "<string>",
"latest_country": "<string>",
"latest_order_date": "<date>",
"has_active_subscription": "<boolean>",
"subscription_count": "<number>",
"ltv": "<string>",
"ltv_currency": "<string>",
"date_created": "<date>"
}
]
}