List tags and tag folders

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_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

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_uuid parameter alone to get tags for a specific resource. Avoid using resource_type as it may return empty results [] if the value doesn't exactly match.

👍
Finding the campaign UUID
The 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_type for 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"
      }
    ]
  }
]

API error responses

Note
The following error codes are commonly returned by Blueshift APIs. Depending on the specific endpoint, not all may apply.

Status code	Description	Example responses
400 Bad Request	The request is invalid due to missing or incorrect parameters. This includes missing fields, invalid values, formatting issues, or conflicts such as duplicate data.	`{ "errors": { "name": ["can't be blank"] } }` `{ "errors": { "startdate": ["can't be blank"] } }`
401 Unauthorized	API authentication failed due to an invalid or missing API key.	`{ "message": "Not authorized" }`
403 Forbidden	The API key does not have sufficient permissions to perform this action.	`{ "message": "Permission denied" }`
404 Not Found	The specified campaign was not found. Verify the campaign UUID.	`{ "message": "Campaign not found" }`
422 Unprocessable Entity	The campaign cannot be paused due to its current status (e.g., already completed or archived). One or more scheduling parameters may be invalid (if applicable).	`{ "message": "Campaign cannot be paused in its current status." }` `{ "message": "Invalid schedule values" }`
429 Too Many Requests	The request limit has been exceeded. Reduce request frequency.	`{ "message": "Rate limit exceeded" }`
500 Internal Server Error	An unexpected server error occurred. Contact support if the issue persists.	`{ "message": "Internal Server Error - Please contact support for more information." }`
502 Bad Gateway	The server received an invalid response. Retry the request.	`{ "message": "Bad Gateway - Please retry the request." }`
503 Service Unavailable	The service is temporarily unavailable. Try again later.	`{ "message": "Service Unavailable - The service is temporarily unavailable. Try again later." }`
504 Gateway Timeout	The server took too long to respond. Retry the request with exponential backoff.	`{ "message": "Gateway Timeout - The server took too long to respond. Retry with exponential backoff." }`

List tags and tag folders

API at a glance

Authentication & testing

How to try it here

Note for developers

Postman collection

Things to know before you start

Finding the campaign UUID

Finding the segment UUID > >

Finding the template UUID > >

Request parameters

Query parameters

Example requests & responses