List user’s subscription groups

Use this endpoint to list and get the subscription groups with the history of a certain user.

If you want to see examples or test this endpoint for Email Subscription Groups:

If you want to see examples or test this endpoint for SMS Subscription Groups:

If you want to see examples or test this endpoint for WhatsApp Groups:

Prerequisites

To use this endpoint, you’ll need an API key with the subscription.groups.get permission.

Rate limit

We apply the default Braze rate limit of 250,000 requests per hour to this endpoint, as documented in API rate limits.

Request parameters

Example request

• multiple users
• sms and whatsapp
• email

1
2
curl --location -g --request GET 'https://rest.iad-01.braze.com/subscription/user/status?external_id={{external_id}}&limit=100&offset=1&phone=+11112223333' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

1
2
curl --location -g --request GET 'https://rest.iad-01.braze.com/subscription/user/status?external_id={{external_id}}&[email protected]&limit=100&offset=0' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

Example response

Only subscription groups that have had a subscription status update in a user’s history will be included in a successful response. This means that newly created subscription groups will not be listed.

1
2
3
4
5
6
7
8
9
10
11
12
13
{
  "success": true,
  "subscription_groups": [
    {
      "subscription_group_id": "group_id_1",
      "subscription_status": "subscribed"
    },
    {
      "subscription_group_id": "group_id_2",
      "subscription_status": "unsubscribed"
    }
  ]
}