v1

latestOpenAPI 3.1.02026-07-246014.7 KB

Get Subscribers

Get a list of subscribers for a shop.

get/api/v2/subscribers

Query parameters

created_at__eqstring date-time

Created at is equal to

created_at__gtstring date-time

Created at is greater than

created_at__gtestring date-time

Created at is greater than or equal to

created_at__ltstring date-time

Created at is less than

created_at__ltestring date-time

Created at is less than or equal to

email__containsstring

Email contains

email__eqstring

Email is equal to

email__instring[]

Email is in

pageinteger

Page number of results to start from

phone_number__containsstring

Phone number contains

phone_number__eqstring

Phone number is equal to

phone_number__instring[]

Phone number is in

shopify_customer_id__containsstring

Shopify customer id contains

shopify_customer_id__eqstring

Shopify customer id is equal to

shopify_customer_id__instring[]

Shopify customer id is in

sortstring

Sorting Order. In {field}__asc or {field}__desc format. Valid fields: created_at, updated_at, phone_number, shopify_customer_id

updated_at__eqstring date-time

Updated at is equal to

updated_at__gtstring date

Updated at is greater than

updated_at__gtestring date-time

Updated at is greater than or equal to

updated_at__ltstring date-time

Updated at is less than

updated_at__ltestring date-time

Updated at is less than or equal to

ps_id__eqinteger

Filters subscribers by their ps_id tracking ID. This ID is stored in the ps_id cookie for subscribers on the front end and is used to uniquely identify a subscriber across sessions.

Headers

X-Postscript-Shop-Tokenstring

Shop API Token. Required for partners. This header should be used only by partners. Shops should include their API token in the Authorization header.

Response

200