List User's Subscription Group - SMS

GET https://{{instance_url}}/subscription/user/status?external_id={{external_id}}&limit=100&offset=1&phone=+11112223333

Use the endpoint below to list and get the subscription groups of a certain user.

If there are multiple users (multiple external ids) who share the same email address, all users will be returned as a separate user (even if they have the same email address or subscription group).

Request Params

KeyDatatypeRequiredDescription
external_idstring(Required*) String

The external_id of the user. Must include at least one and at most 50 external_ids. | | limit | number | | (Optional) Integer

The limit on the maximum number of results returned. Default (and max) limit is 100. | | offset | number | | (Optional) Integer

Number of templates to skip before returning rest of the templates that fit the search criteria. | | phone | string | | (Required*) String

The phone number of the user (must include at least one phone number and at most 50 phone numbers). The recommendation is to provide this in the E.164 format. |

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring