API at a glance

Description: This API returns a simplified list of subscription groups with only essential fields: ID, UUID, and label. This lightweight response is ideal for scenarios where you need quick access to subscription group identifiers without the full metadata, such as populating dropdown menus or performing lookups.

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.

This endpoint returns only three fields per subscription group: subscription_group_id, uuid, and subscription_group_label.
Unlike the full list endpoint, this does not include metadata such as description, author, timestamps, or archived status.
Use case: Use this endpoint when you need to retrieve subscription group identifiers quickly for UI elements (dropdowns, selection lists) or when integrating with systems that only require basic subscription group information.

Request parameters

This endpoint does not require any parameters.

Example requests & responses

Request example

curl --request GET \
     --url https://api.getblueshift.com/api/v1/subscription_groups/index_lite \
     --header 'accept: application/json' \
     --header 'authorization: Basic YWNlZDZlNGYxMWExYWVhOTZmNTJkNDg4M2ZmMjI4Mjg6'

Response example

{
  "subscription_groups": [
    {
      "subscription_group_id": "weekly_updates",
      "uuid": "a1b2c3d4-5678-49ab-9cde-0123456789ab",
      "subscription_group_label": "Weekly Updates"
    },
    {
      "subscription_group_id": "promotions",
      "uuid": "b2c3d4e5-6789-40fa-8123-abcdef123456",
      "subscription_group_label": "Promotions"
    }
  ]
}

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 requested API endpoint does not exist.	`{ "status": "404", "error": "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." }`

200A lite list of subscription groups.

401Unauthorized - API authentication failed.

404Endpoint not found.