get
https://{subdomain}.myshoplaza.com/openapi/2025-06/oauth/access_scopes
The Get Access Scopesretrieves the list of available OAuth access scopes for the token.
This API is essential for:
- Discovering available permissions when building OAuth integrations
- Verifying current access levels for an authenticated app
Request Parameters
Public Request Parameters
Response Explanation
Public Response Parameters
Successful Response
| Parameter | Type | Example | Description |
|---|---|---|---|
code | string | "success" | API response status code |
message | string | "Access scopes retrieved" | Response message |
data.access_scopes | array of objects | - | Available access scopes |
data.access_scopes.handle | string | "read_products" | The scope identifier |
data.access_scopes.description | string | "Read product information" | Human-readable scope description |
data.access_scopes.category | string | "products" | Scope category grouping |
Error Response
| Field | Type | Example | Description |
|---|---|---|---|
code | string | InvalidParameter | Error http message |
message | string | `` | Error message |