Canvas List

v1.0.0

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.

Response

json

Content-Type: application/jsonAuthorization: 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}

Input

{
  "type": "object",
  "properties": {
    "include_archived": {
      "type": "string"
    },
    "last_edit.time[gt]": {
      "type": "string"
    },
    "page": {
      "type": "string"
    },
    "sort_direction": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "object",
  "additionalProperties": true
}