OAuth Scopes

ScopesDescriptionAssociated ApisSupports Tokens

organizations:read

View details of all organizations associated with the user

Get all organizations

user token

organization:read

View details of an organization

Get a single organization

user token

Get all stacks in an Organization

user token

organization.logs:read

View organization logs

Get organization log details

user token

Get organization log item

user token

organization.ownership:write

Create, update of organization ownership

Transfer Organization ownership

user token

organization.ownership:write

Create, update of organization ownership

Transfer Organization ownership

user token

organization.roles:read

View organization level roles

Get all roles in an Organization

user token

organization.share:write

Update, remove organization invitation shares

Add users to Organization

user token

Remove users from organization

user token

Resend pending Organization invitation

user token

organization.share:read

View details of organization invitations shared with users

Get all Organization invitations

user token

user:read

View user details

Get user

user token

user:write

Update user details

Update user

user token

user.assignments:read

View user assignments

Get all Tasks

user token

cm.stacks.management:read

View all stacksGet a single stack

user token

cm.stacks.management:write

Create, update, remove stacksCreate stack

user token

Update stack

user token

Delete stack

user token

cm.stack.users:read

View users associated with a stackGet all users of a stack

user token

cm.stack.users:write

Update user roles and user associations with a stackUpdate User Role

user token

cm.stack.management:write

Update stack management propertiesTransfer stack ownership to other users

user token

cm.stack.settings:read

Update stack settingsAdd stack settings

user token

Reset stack settings

user token

cm.stack:share

Share stack invitation with usersShare a stack

user token

cm.stack:unshare

Unshare stack invitationsUnshare a stack

user token

cm.stack.deliveryTokens:read

View delivery tokens associated with a stackGet all delivery tokens

user token

Get a single delivery token

user token

cm.stack.deliveryTokens:write

Create, update, remove delivery tokens in a stackCreate delivery token

user token

Update delivery token

user token

Delete delivery token

user token

cm.stack.managementTokens:read

View management tokens associated with a stackGet all management tokens

user token

Get a single management token

user token

cm.stack.managementTokens:write

Create, update, remove management tokens in a stackCreate management token

user token

Update management token

user token

Delete management token

user token

cm.content-types.management:read

View all content typesGet all content types

user token, app token

Get a single content type

user token, app token

cm.content-types.management:write

Create, update, remove content typesCreate a content type

user token, app token

Create content type with select field

user token, app token

Create content type with JSON RTE

user token, app token/p>

Create a content type with embedded RTE objects

user token, app token

Create Content Type with Extension Field

user token, app token

Create content type with JSON RTE plugin

user token, app token

Update Content Type

user token, app token

Update content type with embedded RTE objects

user token, app token

Set Field Visibility Rule for Content Type

user token, appp token

Delete Content Type

user token, app token

cm.content-type:read

View content type detailsGet all references of content type

user token, app token

cm.content-types:export

Export content typesExport a content type

user token, app token

cm.content-types:import

Import content typesImport a content type

user token, app token

cm.content-types:export

Export content typesExport a content type

user token, app token

cm.global-fields.management:read

View all global fieldsGet all global fields

user token, app token

Get a single global field

user token, app token

cm.global-fields.management:write

Create, update, remove global fieldsCreate a global field

user token, app token

Update a global field

user token, app token

Delete global field

user token, app token

cm.global-fields:import

Export global fieldsExport a global field

user token, app token

cm.entries.management:read

View all entriesGet all entries

user token, app token

Get a single entry

user token, app token

Get information on embedded RTE objects

user token, app token

cm.entries.management:write

Create, update, remove entriesCreate an entry

user token, app token

Create an entry with JSON RTE

user token, app token

Create an entry with embedded entries in RTE

user token, app token

Create an entry with embedded assets in RTE

user token, app token

Create an entry with master locale

user token, app token

Update an entry

user token, app token

Update an entry with JSON RTE

user token, app token

Update embedded RTE objects

user token, app token

Delete an entry

user token, app token

Localize an entry

user token, app token

cm.entry:write

Update details associated with an entrySet Version Name for Entry

user token, app token

Delete Version Name of Entry

user token, app token

Unlocalize an entry

user token, app token

cm.entry:read

View details associated with an entryGet Details of All Versions of an Entry

user token, app token

Get references of an entry

user token, app token

Get languages of an entry

user token, app token

cm.entries:export

Export entriesExport an entry

user token, app token

cm.entries:import

Import entriesImport an entry

user token, app token

Import an existing entry

user token, app token

cm.entry:publish

Publish an entryPublish an entry

user token, app token

cm.entry:unpublish

Unpublish an entryUnpublish an entry

user token, app token

cm.entry.workflow:write

Create a workflow for an entrySet entry workflow stage

user token, app token

Request/Accept/Reject Entry Publish Request

user token, app token

cm.bulk-operations:publish

Publish bulk operationsPublish an entry with references

user token, app token

Publish entries and assets in bulk

user token, app token

cm.bulk-operations:unpublish

Unpublish bulk operationsUnpublish entries and assets in bulk

user token, app token

cm.bulk-operations:delete

Delete bulk operationsDelete entries and assets in bulk

user token, app token

cm.bulk-operations:workflow

Workflow bulk operationsUpdate workflow details in bulk

user token, app token

cm.assets.management:read

View all assetsGet all assets

user token, app token

Get an asset

user token, app token

Get assets of a specific folder

user token, app token

Get assets and subfolders of a parent folder

user token, app token

Get either only images or videos

user token, app token

Get a single folder

user token, app token

Get a single folder by name

user token, app token

Get subfolders of a parent folder

user token, app token

cm.assets.management:write

Create, update, remove assetsUpload asset

user token, app token

Replace asset

user token, app token

Generate permanent asset URL

user token, app token

Delete asset

user token, app token

Update asset revision

user token, app token

Update asset

user token, app token

Create a folder

user token, app token

Update or move folder

user token, app token

Delete a folder

user token, app token

cm.assets:download

Download assetsDownload an asset with permanent URL

user token, app token

cm.assets.rt:read

View all RTE assetsGet information on RTE assets

user token, app token

cm.asset:write

Create, update, remove RTE assetsSet Version Name for Asset

user token, app token

Delete Version Name of Asset

user token, app token

cm.asset:read

View asset detailsGet Details of All Versions of an Asset

user token, app token

Get asset references

user token, app token

cm.asset:publish

Publish an assetPublish an asset

user token, app token

cm.asset:unpublish

Unpublish an assetUnpublish an asset

user token, app token

cm.extensions.management:read

View all extensionsGet all custom fields

user token, app token

Get a single custom field

user token, app token

Get all widgets

user token, app token

Get widgets of a content type

user token, app token

Get All Dashboard Widgets

user token, app token

Get all JSON RTE plugins

user token, app token

Get a single JSON RTE plugin

user token, app token

cm.extensions.management:write

Create, update, remove extensionsUpload a custom field

user token, app token

Create a custom field with source URL

user token, app token

Create a custom field with source code

user token, app token

Update a custom field

user token, app token

Delete custom field

user token, app token

Upload a widget

user token, app token

Create widget with source URL

user token, app token

Create widget with source code

user token, app token

Update a widget

user token, app token

Delete a widget

user token, app token

Upload Dashboard Widget

user token, app token

Create a Dashboard Widget with Source URL

user token, app token

Create a Dashboard Widget with Source code

user token, app token

Update the Dashboard Widget

user token, app token

Delete the Dashboard Widget

user token, app token

Create a JSON RTE plugin with source URL

user token, app token

Update a JSON RTE plugin

user token, app token

Delete JSON RTE plugin

user token, app token

cm.releases.management:read

View all releasesGet all Releases

user token, app token

Get a single Release

user token, app token

cm.releases.management:write

Create, update, remove releasesCreate a Release

user token, app token

Update a Release

user token, app token

Delete a Release

user token, app token

cm.release:read

View details associated with a releaseGet all items in a Release

user token, app token

cm.release:write

Update details associated with a releaseAdd a single item to a Release

user token, app token

Add multiple items to a Release

user token, app token

Remove an item from a Release

user token, app token

Delete multiple items from a Release

user token, app token

Update Release items to their latest versions

user token, app token

cm.release:deploy

Deploy a releaseDeploy a Release

user token, app token

cm.release:clone

Clone a releaseClone a Release

user token, app token

cm.workflows.management:read

View all workflowsGet all workflows

user token, app token

Get a single workflow

user token, app token

Get publish rules by content types

user token, app token

cm.workflows.management:write

Create, update, remove workflowsCreate a workflow

user token, app token

Add or update workflow details

user token, app token

Disable workflow

user token, app token

Enable workflow

user token, app token

Delete workflow

user token, app token

cm.workflows.publishing-rules:write

Create, update, remove workflow publishing rulesCreate publish rules

user token, app token

Update publish rules

user token, app token

Delete publish rules

user token, app token

cm.workflows.publishing-rules:read

View all workflow publishing rulesGet all publish rules

user token, app token

Get a single publish rule

user token, app token

cm.labels.management:read

View all labelsGet all labels

user token, app token

Get a single label

user token, app token

cm.labels.management:write

Create, update, remove labelsAdd label

user token, app token

Update label

user token, app token

Delete label

user token, app token

cm.languages.management:read

View all languagesGet all languages

user token, app token

Get a language

user token, app token

cm.languages.management:write

Create, update, remove languagesAdd a language

user token, app token

Update language

user token, app token

Delete language

user token, app token

Set a fallback language

user token, app token

Update fallback language

user token, app token

cm.environments.management:read

View all environmentsGet all environments

user token, app token

Get a single environment

user token, app token

cm.environments.management:write

Create, update, remove environmentsAdd an environment

user token, app token

Update environment

user token, app token

Delete environment

user token, app token

cm.roles.management:read

View all rolesGet all roles

user token, app token

Get a single role

user token, app token

cm.roles.management:write

Create, update, remove rolesCreate a role

user token, app token

Update role

user token, app token

Delete role

user token, app token

cm.webhooks.management:read

View all webhooksGet all webhooks

user token, app token

Get webhook

user token, app token

cm.webhooks.management:write

Create, update, remove webhooks

https://www.contentstack.com/d...

user token, app token

Update webhook

user token, app token

Delete webhook

user token, app token

Retry a webhook

user token, app token

cm.webhooks:export

Export webhooksExport a Webhook

user token, app token

cm.webhooks:import

Import webhooksImport a Webhook

user token, app token

Import an Existing Webhook

user token, app token

cm.webhook:read

View webhook detailsGet executions of a webhook

user token, app token

Get latest execution log of a webhook

user token, app token

cm.audit-logs:read

View all audit logsGet audit log

user token, app token

Get audit log item

user token, app token

cm.publish-queue.management:read

View all publish queuesGet publish queue

user token, app token

Get publish queue activity

user token, app token

cm.publish-queue.management:write

Create, update, remove publish queuesCancel scheduled action

user token, app token

Was this article helpful?

Thanks for your feedbackSmile-icon

On This Page

^