The REST Admin API is a legacy API as of October 1, 2024. Starting April 1, 2025, all new public apps must be built exclusively with the GraphQL Admin API. For details and migration steps, visit our migration guide.
Access
The AccessScope resource allows you to retrieve the permissions that a merchant has granted to an app, such as read_orders and write_products. These permissions allow apps to access data from a shop, and are granted when a merchant installs the app or updates an existing installation of the app.
The list of access scopes retrieved is based on the access token for the request. It returns only those access scopes that are associated with the token.
For more information about access scopes, see the access scopes API reference.
If your app is already installed on a shop and you want the merchant to grant additional access scopes, you need to redirect the merchant to the app install page with the additional requested scopes. After a merchant installs the updated app, any subsequent calls made to the AccessScope resource will return the updated list of granted access scopes.
Endpoints
- get/admin/oauth/access_
scopes. json Get a list of access scopes
Anchor to GET request, Get a list of access scopesgetGet a list of access scopes
Retrieves a list of access scopes associated with the access token.
List all scopes
List all scopes
/admin/oauth/access_
Response
examples
List all scopes
curl -X GET "https://your-development-store.myshopify.com/admin/oauth/access_scopes.json" \ -H "X-Shopify-Access-Token: {access_token}"await admin.rest.resources.AccessScope.all({ session: session, });# Session is activated via Authentication test_session = ShopifyAPI::Context.active_session ShopifyAPI::AccessScope.all( session: test_session, )// Session is built by the OAuth process await shopify.rest.AccessScope.all({ session: session, });response
HTTP/1.1 200 OK{"access_scopes":[{"handle":"read_products"},{"handle":"write_orders"},{"handle":"read_orders"}]}