Canvas List Endpoint
get
/canvas/list
This endpoint allows you to export a list of Canvases, including the name, Canvas API Identifier and associated Tags. The Canvases are returned in groups of 100 sorted by time of creation (oldest to newest by default).
Archived Canvases will not be included in the API response unless the include_archived field is specified. Canvases that are stopped but not archived, however, will be returned by default.
Request Parameters
| Parameter | Required | Data Type | Description |
|---|---|---|---|
page |
No | Integer | The page of Canvases to return, defaults to 0 (returns the first set of up to 100) |
include_archived |
No | Boolean | Whether or not to include archived Canvases, 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. |
last_edit.time[gt] |
No | Time | Filters the results and only returns Canvases that were edited greater than the time provided till now. Format is yyyy-MM-DDTHH:mm:ss |
Example Request
1
2
curl --location -g --request GET 'https://rest.iad-01.braze.com/canvas/list?page=1&include_archived=false&sort_direction=desc&last_edit.time[gt]=2020-06-28T23:59:59-5:00' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'
Response
1
2
3
4
5
6
7
8
9
10
11
12
13
14
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
"canvases" : [
{
"id" : (string) Canvas API Identifier,
"last_edited": (ISO 8601 string) the last edited time for the message,
"name" : (string) Canvas name,
"tags" : (array) tag names associated with the Canvas,
},
... (more Canvases)
],
"message": (required, string) the status of the export, returns 'success' when completed without errors
}
tip:
For help with CSV and API exports, visit our troubleshooting article here.
Edit this page on GitHub