List campaigns

API at a glance

Description: This API returns a list of campaigns based on the specified search criteria. You can filter by name, author, creation date, start date, status, campaign type, and archived status. Results are paginated.

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

Pagination: Use per_page and page parameters to control result pagination.
Default behavior for one-time campaigns: If startdate is not specified, the response contains only one-time campaigns with a start date within the last 30 days. For other campaign types, all campaigns are returned regardless of start date.
Multiple filters: You can combine multiple query parameters to narrow down results.
Campaign types: Use exec_term to filter by type: one_time, recurring, on_going (segment triggered), transactional (event triggered), or onsite (live content).
Use case: Best for retrieving lists of campaigns for dashboards, reports, or administrative interfaces.

Request parameters

Check out the request parameters

Query parameters

Note: All query parameters are optional.

Parameter	Type	Required	Description
`name`	`string`	❌ No	Search for campaigns that contain the specified string in the name of the campaign.
`email`	`string`	❌ No	Search for campaigns created by specified author.
`created_after`	`string (ISO 8601)`	❌ No	Search for campaigns created after specified date and time.
`created_before`	`string (ISO 8601)`	❌ No	Search for campaigns created before specified date and time.
`startdate`	`string (ISO 8601)`	❌ No	Search for campaigns that started after specified date and time. If the start date is not specified, for one time campaigns, response contains only campaigns that have a start date within the last 30 days. For other campaign types, if start date is not specified, all campaigns are returned irrespective of start date.
`archived`	`string`	❌ No	Search for campaigns with specified archived status. Set as `true` for archived campaigns.
`status`	`string`	❌ No	Search for campaigns with specified status.
`exec_term`	`string`	❌ No	Search for campaigns of specified type. Options: `one_time`, `recurring`, `on_going` (segment triggered), `transactional` (event triggered), `onsite` (live content).
`per_page`	`string`	❌ No	Specify the number of records to be returned per page.
`page`	`string`	❌ No	Specify the page number for the search results.

Example requests & responses

List campaigns with filters

Request

curl --request GET \
     --url 'https://api.getblueshift.com/api/v2/campaigns.json?status=launched&exec_term=one_time&per_page=4&page=3' \
     --header 'accept: application/json' \
     --header 'authorization: Basic <YOUR_API_KEY>'

Response

[
  {
    "name": "Members-only Banner",
    "status": "launched",
    "startdate": "2024-05-22T02:26:00.000Z",
    "created_at": "2024-05-21T07:05:00.000Z",
    "updated_at": "2024-05-24T07:05:00.000Z",
    "uuid": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "exec_term": "one_time",
    "next_execution_scheduled_at": null,
    "archived": false,
    "holdout_percentage": 0,
    "segment_uuid": "seg-uuid-123",
    "segment_name": "VIP Members",
    "author": "Jane Doe",
    "email": "[email protected]",
    "prioritization_label": null
  }
]

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." }`