API at a glance
Description: This API retrieves all tags and tag folders from your Blueshift account. Tags are folder-based entities used to organize resources like campaigns, templates, and segments.
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_valueYou 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
- Tag structure: Tags are organized in folders. Each folder contains its own isolated set of tags.
- Organizing resources: Use tags to organize and categorize your campaigns, templates, segments, and other resources. Learn more about tags and tag folders.
- Best practice: Use
resource_uuidparameter alone to get tags for a specific resource. Avoid usingresource_typeas it may return empty results[]if the value doesn't exactly match.
Finding the campaign UUIDThe campaign UUID is visible in the browser's address bar when you open a campaign. For example:
https://app.getblueshift.com/dashboard#/app/campaigns/<CAMPAIGN_UUID>/edit_v3/journey
Finding the segment UUID > >You can find the segment UUID in the URL when viewing a segment in the Blueshift app. For example, if you open a segment in the Blueshift app, its URL looks like
https://app.getblueshift.com/dashboard#/app/segments/<SEGMENT_UUID>/edit/events.
Finding the template UUID > >You can find the template UUID in the URL when viewing a segment in the Blueshift app. For example, if you open an email template (using visual editor) in the Blueshift app, its URL looks like
https://app.getblueshift.com/dashboard#/app/email_template_studio/8<TEMPLATE_UUID>/edit/templates/visual.
- Tagged items: Response includes entities tagged with each tag (campaigns, templates, segments, etc.) and shows
usage_typefor organizational tags. - Use case: Best for auditing tag structure, retrieving tag metadata, and integrating tag data with external systems.
Request parameters
Check out the request parameters
Query parameters
Note: All query parameters are optional.
| Parameter | Type | Required | Description |
|---|---|---|---|
resource_type | string | ❌ No | Filter by resource type (e.g., Campaign, Segment). |
resource_uuid | string | ❌ No | Filter by resource UUID. Find UUID in resource URL (e.g., campaign, segment). |
Example requests & responses
List all tags and folders
GET /api/v1/tag_contexts/list[
{
"id": 1795,
"account_id": 233,
"name": "Audience_List",
"description": "Type of audience list",
"color": "#f9c060",
"allowed_tags": "marketing_incubator,marketing,tradeshow",
"usage_type": "organization",
"tagged_items": [
{
"uuid": "311499b0-35b9-4f1a-9f04-aa600078a447",
"name": "Product Launch – Email + Push (Cross-channel)",
"resource_type": "Campaign",
"tags": "Audience_List:marketing,marketing_incubator|Country:China,Denmark,France,Italy,Korea,Spain,US|Region:East Coast,Midwest,West Coast"
}
]
}
]Filter tags by resource UUID
GET /api/v1/tag_contexts/list?resource_uuid=311499b0-35b9-4f1a-9f04-aa600078a447[
{
"id": 1795,
"account_id": 233,
"name": "Audience_List",
"description": "Type of audience list",
"color": "#f9c060",
"allowed_tags": "marketing_incubator,marketing,tradeshow",
"usage_type": "organization",
"tagged_items": [
{
"uuid": "311499b0-35b9-4f1a-9f04-aa600078a447",
"name": "Product Launch – Email + Push (Cross-channel)",
"resource_type": "Campaign",
"tags": "Audience_List:marketing,marketing_incubator|Country:China,Denmark,France,Italy,Korea,Spain,US|Region:East Coast,Midwest,West Coast"
}
]
},
{
"id": 1855,
"account_id": 233,
"name": "Country",
"description": "Country",
"color": "#76ef4f",
"allowed_tags": "US, China, Korea, Denmark, Italy, France, Spain",
"usage_type": "organization",
"tagged_items": [
{
"uuid": "311499b0-35b9-4f1a-9f04-aa600078a447",
"name": "Product Launch – Email + Push (Cross-channel)",
"resource_type": "Campaign",
"tags": "Audience_List:marketing,marketing_incubator|Country:China,Denmark,France,Italy,Korea,Spain,US|Region:East Coast,Midwest,West Coast"
}
]
}
]The request was invalid or cannot be otherwise served. An accompanying error message will explain further.
Resource not found. This can happen due to resource conflicts. Retry with exponential backoff. If the issue persists, contact Blueshift.
Conflict error, please retry. The request could not be completed due to a conflict with the current state of the target resource. Re-try with exponential backoff.
You can upload up to 50 users in an API call.
Rate limit exceeded. Too many requests. Contact us on [email protected] for recommended throughput.
Internal server error. Contact Blueshift for more information.
Service unavailable, please retry. Bad gateway. Retry with exponential backoff.
Service unavailable, please retry. Service unavailable. Retry with exponential backoff.
Service unavailable, please retry. Gateway timeout. Retry with exponential backoff.