Get Subscribers

get

https://api.postscript.io/api/v2/subscribers

Get a list of subscribers for a shop.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

created_at__eq

date

Created at is equal to

created_at__gt

date

Created at is greater than

created_at__gte

date

Created at is greater than or equal to

created_at__lt

date

Created at is less than

created_at__lte

date

Created at is less than or equal to

email__contains

string

Email contains

email__eq

string

Email is equal to

email__in

array of strings

Email is in

email__in

page

int32

Page number of results to start from

phone_number__contains

string

Phone number contains

phone_number__eq

string

Phone number is equal to

phone_number__in

array of strings

Phone number is in

phone_number__in

shopify_customer_id__contains

string

Shopify customer id contains

shopify_customer_id__eq

string

Shopify customer id is equal to

shopify_customer_id__in

array of strings

Shopify customer id is in

shopify_customer_id__in

sort

string

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

updated_at__eq

date

Updated at is equal to

updated_at__gt

date

Updated at is greater than

updated_at__gte

date

Updated at is greater than or equal to

updated_at__lt

date

Updated at is less than

updated_at__lte

date

Updated at is less than or equal to

ps_id__eq

int32

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-Token

string

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

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400