List campaigns

get

https://api.getblueshift.com/api/v2/campaigns.json

Use this endpoint to get the list of campaigns.

Query Params

name

string

Search for campaigns that contain the specified string in the name of the campaign.

string

Search for campaigns created by specified author.

created_after

date-time

Search for campaigns created after specified date and time.

created_before

date-time

Search for campaigns created before specified date and time.

startdate

date-time

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

Search for campaigns with specified archived status. Set as true for archived campaigns.

status

string

Search for campaigns with specified status.

exec_term

string

Search for campaigns of specified type. Value can be one_time, recurring, on_going (segment triggered), transactional (event triggered), or onsite (live content).

per_page

string

Specify the number of records to be returned per page

page

string

Specify the page number for the search results.

Responses

Language

Credentials

Basic

base64

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

400Bad 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.

401Unauthorized - API authentication failed due to an invalid or missing API key.

403Forbidden - The API key does not have sufficient permissions to perform this action.

404Not Found - The requested resource was not found.

422Unprocessable Entity - The request was well-formed but contains semantic errors.

429Too Many Requests - The request limit has been exceeded. Reduce request frequency.

500Internal Server Error - An unexpected server error occurred. Contact support if the issue persists.

502Bad Gateway - The server received an invalid response. Retry the request.

503Service Unavailable - The service is temporarily unavailable. Try again later.

504Gateway Timeout - The server took too long to respond. Retry the request with exponential backoff.