API at a glance

Description: This API returns complete details for a single subscription group, including its ID, UUID, label, description, author, timestamps, and archived status. Use this endpoint when you need to fetch information about a specific subscription group.

Authentication & testing

Testing the API on this page

How to try it here

Use your User API Key as the Username (leave Password blank).

Select the appropriate API endpoint based on your Blueshift region.

Enter the necessary parameters and click Try It to run the request.

Authentication using Base64 encoding

Note for developers

API requests require authentication using HTTP Basic Authentication with an API key. The API key serves as the username, while the password field should be left empty. The format to encode is: your_api_key: (note the trailing colon).

This string must be Base64-encoded and included in the request's Authorization header as follows:

Authorization: Basic encoded_value

You can generate the encoded value using a trusted Base64 encoder.

Postman collection

Try it with Postman: Explore the API using Blueshift's Postman collection.

Things to know before you start

📖 Subscription groups – user guide
To learn more about subscription groups and how to create and manage them in Blueshift, see the Subscription groups overview.

You must provide the subscription group UUID as a path parameter.

The response includes all metadata for the subscription group, including creation and update timestamps, author information, and archived status.
If the UUID does not exist or is invalid, the API returns a 404 Not Found error.
Use case: Retrieve detailed information about a specific subscription group for display in preference centers, configuration tools, or when validating subscription group references.

Request parameters

Check out the request parameters

Path parameters

Parameter	Type	Required	Description
`uuid`	`string`	✅ Yes	UUID of the subscription group. You can get the subscription group's UUID from its URL. For example, if you open a subscription group on the Blueshift app, its URL looks like `https://app.getblueshift.com/dashboard#/app/subscription-groups/09de09a9-243f-494e-8f7f-44c610692a74/edit`, where the UUID is `09de09a9-243f-494e-8f7f-44c610692a74`.

You can find the subscription group UUID in the URL when viewing or editing a subscription group in the Blueshift app.

Example requests & responses

Request example

curl --request GET \
     --url https://api.getblueshift.com/api/v1/subscription_groups/a1b2c3d4-5678-49ab-9cde-0123456789ab \
     --header 'accept: application/json' \
     --header 'authorization: Basic YWNlZDZlNGYxMWExYWVhOTZmNTJkNDg4M2ZmMjI4Mjg6'

Response example

{
  "subscription_group": {
    "subscription_group_id": "weekly_updates",
    "description": "Weekly marketing newsletter",
    "user_id": 4821,
    "account_id": 182,
    "uuid": "a1b2c3d4-5678-49ab-9cde-0123456789ab",
    "created_at": "2025-10-12T08:15:27.000Z",
    "updated_at": "2025-11-03T12:44:10.000Z",
    "subscription_group_label": "Weekly Updates",
    "archived": false,
    "author": "Emily Johnson"
  }
}

API error responses

Status code	Description	Example response
401 Unauthorized	API authentication failed due to an invalid or missing API key.	`{ "message": "Not authorized" }`
404 Not Found	The subscription group with the specified UUID was not found.	`{ "message": "Not Found" }`
429 Too Many Requests	The request limit has been exceeded.	`{ "message": "Rate limit exceeded" }`
500 Internal Server Error	An unexpected server error occurred.	`{ "message": "Internal Server Error - Please contact support for more information." }`
502 Bad Gateway	The server received an invalid response.	`{ "message": "Bad Gateway - Please retry the request." }`
503 Service Unavailable	The service is temporarily unavailable.	`{ "message": "Service Unavailable - Try again later." }`
504 Gateway Timeout	The server took too long to respond.	`{ "message": "Gateway Timeout - Retry with exponential backoff." }`

200Subscription group details.

401Unauthorized - API authentication failed.

404Subscription group not found.