OAuth scopes, or permissions, let you specify precisely how your application needs to access a user’s Marq account.
You should only specify the scopes you need to satisfy your use case and no more.
User permissions
The user that authorizes your app must have permission to access the corresponding feature. For example, if the user does not have permission to view a project in Marq, then your request to the project resource will return a 403 - Forbidden status.
Summary of all OAuth scopes
The following scopes are available for an application to obtain authorization from a user or account.
| Scope | Description | User | Account |
|---|---|---|---|
print.orders | Allows applications to retrieve and update print orders and job statuses. | ✅ | |
data-service.admin | Allows applications to create, retrieve, and update data automation sets that are used to populate images and text inside a Marq project. | ✅ | |
project.templates | Allows applications to retrieve and update brand template data.project.templates:readonly is minimum scope required to retrieve templates. | ✅ | ✅ |
project.content | Allows applications to retrieve folders and projects on behalf of a user or an account.project.content:readonly is minimum scope required to retrieve projects. | ✅ | ✅ |
project.content.approval | Allows applications to retrieve and update project approval statuses on behalf of a user or an account.project.content.approvals :readonly is minimum scope required to retrieve project approvals without creating or updating an approval. | ✅ | ✅ |
project.content.export | Allows applications to export projects into file types (e.g. PDF, PNG, JPG, etc.) on behalf of a user or an account. | ✅ | ✅ |
account.user | Allows applications to create, retrieve, update, and delete users and groups in Marq via SCIM endpoints. | ✅ | ✅ |
offline_access | Continue to perform authorized actions when you’re not logged in (required to refresh account tokens). | ✅ | |
account.webhook | Allows applications to register a webhook notification URL. | ✅ |