Scopes
The Canva REST APIs use scopes to specify the access an access token grants. The scopes your app can request depend on your app type:
- Public or private apps act on behalf of a user, using the OAuth authorization code flow.
- Service apps act on behalf of your app itself, using the OAuth client credentials flow.
Scopes are explicit. A scope that grants write access doesn't also grant read access.
For example, asset:write doesn't grant asset:read access. To get both read and write access to a user's assets, request both scopes. The same applies to service apps: request each service: scope your app needs.
Scopes for public or private apps
Use these scopes when your app accesses data or performs actions on behalf of a user. Request them as part of the user authorization flow.
Scope | Description |
|---|---|
asset:read | View the metadata for the user's assets, such as uploaded images. |
asset:write | Upload, update, or delete assets on the user's behalf. |
brandtemplate:content:read | Read the content of the brand templates associated with the user's brand. |
brandtemplate:content:write | Publish brand templates associated with the user's brand. |
brandtemplate:meta:read | View the metadata of the brand templates associated with the user's brand. |
collaboration:event | Receive webhook notifications about events relevant to the user. |
comment:read | View the comments on the user's designs, and the associated metadata. |
comment:write | Create comments and replies on the user's designs. |
design:content:read | View the contents of the user's designs. |
design:content:write | Create designs on the user's behalf. |
design:meta:read | View the metadata of the user's designs. |
email | Read user email address through OIDC. |
folder:permission:write | Set, update, or remove permissions assigned to the user's folders. |
folder:read | View the metadata and contents of the user's folders, including their Projects
folder. |
folder:write | Add, move, or remove the user's folders. It also lets you edit folder metadata,
such as the folder's name. |
openid | Read user information through Open ID Connect (OIDC). |
profile | Read user profile information through OIDC. |
profile:read | Read a user's profile and account information. |
For example, to read a user's design metadata, request the design:meta:read scope. To also write to the user's folders, request both design:meta:read and folder:write.
Scopes for service apps
Use these scopes when your app accesses resources on its own behalf, without acting on behalf of a user. Request them when generating an access token using the client credentials flow.
Scope | Description |
|---|---|
service:asset:read | View the metadata for the app's assets, such as uploaded images. |
service:asset:write | Upload assets on the app's behalf. |
service:brandtemplate:content:read | Read the content of the brand templates associated with the developer's brand. |
service:brandtemplate:meta:read | View the metadata of the brand templates associated with the developer's brand. |
service:design:content:read | View the contents of the app's designs. |
service:design:content:write | Create designs on the app's behalf. |
service:design:meta:read | View the metadata of the app's designs. |
service:folder:write | Move designs, assets, and folders between folders on the app's behalf. |