Skip to main content

Scopes

OAuth 2.0 Scopes for Apple Business API

Third-party partners are unable to specify individual scopes when requesting an authorization code. All scopes will be enabled when a third-party partner is authorized by a company.

Scopes List
OAUTH_BRAND_READ
OAUTH_BRAND_WRITE
OAUTH_LOCATION_READ
OAUTH_LOCATION_WRITE
OAUTH_MEDIA_READ
OAUTH_MEDIA_WRITE
OAUTH_SHOWCASE_READ
OAUTH_SHOWCASE_WRITE

Scopes and Permissions

Once authorized, all the following scopes are enabled via the third-party partner's platform.

Brand API & Brand Asset API

ScopesPermissions
OAUTH_BRAND_READGet business and business asset resources
OAUTH_BRAND_WRITECreate, get, update, and delete business and business asset resources

Location API & Location Asset API

Scopes
OAUTH_LOCATION_READGet location and location asset resources
OAUTH_LOCATION_WRITECreate, get, update, and delete location and location asset resources

Media API

ScopesPermissions
OAUTH_MEDIA_READGet image metadata
OAUTH_MEDIA_WRITEImport and upload an image

Showcase API & Showcase Creative API

ScopesPermissions
OAUTH_SHOWCASE_READGet showcase and showcase creative resources
OAUTH_SHOWCASE_WRITECreate, get, update, delete, extend, and deactivate showcase
Create, get, update, and delete showcase creative resources