These docs are for v1.0. Click to read the latest docs for v2.0.

Get Subscriber

Get a subscriber for a shop.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

You can query for a subscriber using either their id, email, or phone number. One of the query params is required in order to lookup the subscriber.

The is_pending field in the response tells you if the subscriber has confirmed their phone number or not. Whenever a new subscriber is added, they are required to confirm their phone number in order to receive messages. See Create Subscriber with Keyword for more information on compliance.

❗️

At least one query parameter is required

One of the following params are required in the request:

  • id
  • email
  • phone_number
Query Params
string

ID of the subscriber you're looking up.

string

Email of the subscriber you're looking up.

string
Defaults to 555-555-5555

Phone number of the subscriber you're looking up.

Headers
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
LoadingLoading…
Response
Choose an example:
application/json