Scopes

The scope parameter specifies the types of access that your integration needs for a user's account. The list of possible scopes used in the Connect APIs are shown below:

ScopeDescription
asset:readView the metadata for the user's assets, such as uploaded images.
asset:writeUpload, update, or delete assets on the user's behalf.
brandtemplate:content:readRead the content of the brand templates associated with the user's brand.
brandtemplate:meta:readView the metadata of the brand templates associated with the user's brand.
collaboration:eventReceive webhook notifications about events relevant to the user.
comment:readView the comments on the user's designs, and the associated metadata.
comment:writeCreate comments and replies on the user's designs.
design:content:readView the contents of the user's designs.
design:content:writeCreate designs on the user's behalf.
design:meta:readView the metadata of the user's designs.
design:permission:readView the permissions assigned to a user's designs.
design:permission:writeSet, update, or remove the permissions assigned to the user's designs.
folder:permission:readView permissions assigned to a user's folders.
folder:permission:writeSet, update, or remove permissions assigned to the user's folders.
folder:readView the metadata and contents of the user's folders, including their Projects folder.
folder:writeAdd, move, or remove the user's folders. It also lets you edit folder metadata, such as the folder's name.
profile:readRead a user's profile and account information.

For example, if you just require your integration to read design metadata, you can use the design:meta:read scope. If you require your integration to read designs, as well as write to any folder, you can use both the design:meta:read and the folder:write scopes.