Campaigns List Endpoint
get
/campaigns/list
This endpoint allows you to export a list of campaigns, each of which will include its name, Campaign API Identifier, whether it is an API Campaign, and Tags associated with the campaign. The campaigns are returned in groups of 100 sorted by time of creation (oldest to newest by default).
Request Parameter Details
| Parameter | Required | Data Type | Description |
|---|---|---|---|
api_key |
Yes | String | App Group REST API Key |
page |
No | Integer | The page of campaigns to return, defaults to 0 (returns the first set of up to 100) |
include_archived |
No | Boolean | Whether or not to include archived campaigns, defaults to false |
sort_direction |
No | String | Pass in the value desc to sort by creation time from newest to oldest. Pass in asc to sort from oldest to newest. If sort_direction is not included, the default order is oldest to newest. |
Example URL
https://rest.iad-01.braze.com/campaigns/list?api_key=75480f9a-4db8-4057-8b7e-4d59bfd73709&page=1&include_archived=true
Campaign List Endpoint API Response
1
2
3
4
5
6
7
8
9
10
11
12
13
Content-Type: application/json
{
"message": (required, string) the status of the export, returns 'success' when completed without errors,
"campaigns" : [
{
"id" : (string) Campaign API Identifier,
"name" : (string) campaign name,
"is_api_campaign" : (boolean) whether the campaign is an API Campaign,
"tags" : (array) tag names associated with the campaign
},
...
]
}
Edit this page on GitHub