/v1/brand-templates
GET {{baseUrl}}/v1/brand-templates?query=<string>&continuation=<string>&ownership=<string>&sort_by=<string>
This API is currently provided as a preview. Be aware of the following:
- There might be unannounced breaking changes.
- Any breaking changes to preview APIs won't produce a new API version.
- Public integrations that use preview APIs will not pass the review process, and can't be made available to all Canva users.
To use this API, your integration must act on behalf of a user that's a member of a Canva Enterprise organization.
Get a list of the brand templates the user has access to.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
query | string | Lets you search the brand templates available to the user using a search term or terms. | |
continuation | string | If the success response contains a continuation token, the user has access to more | |
| brand templates you can list. You can use this token as a query parameter and retrieve | |||
| more templates from the list, for example | |||
/v1/brand-templates?continuation={continuation}. | |||
| To retrieve all the brand templates available to the user, you might need to make | |||
| multiple requests. | |||
ownership | string | Filter the brand templates to only show templates created by a particular user. | |
| Provide a Canva user ID and it will filter the list to only show brand templates | |||
| created by that user. The 'owner' of a template is the user who created the design, | |||
| and the owner can't be changed. | |||
sort_by | string | Sort the list of brand templates. This can be one of the following: |
RELEVANCE: (Default) Sort results using a relevance algorithm.MODIFIED_DESCENDING: Sort results by the date last modified in descending order.MODIFIED_ASCENDING: Sort results by the date last modified in ascending order.TITLE_DESCENDING: Sort results by title in descending order.TITLE_ASCENDING: Sort results by title in ascending order. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"items":[{"create_url":"\u003cstring\u003e","id":"\u003cstring\u003e","title":"\u003cstring\u003e","view_url":"\u003cstring\u003e","thumbnail":{"height":"\u003cinteger\u003e","url":"\u003cstring\u003e","width":"\u003cinteger\u003e"}},{"create_url":"\u003cstring\u003e","id":"\u003cstring\u003e","title":"\u003cstring\u003e","view_url":"\u003cstring\u003e","thumbnail":{"height":"\u003cinteger\u003e","url":"\u003cstring\u003e","width":"\u003cinteger\u003e"}}],"continuation":"\u003cstring\u003e"}