Skip to main content
GET
/
roles
/
pages
List role pages
curl --request GET \
  --url https://api.salesive.com/api/v1/roles/pages \
  --header 'Authorization: Bearer <token>'
{
  "status": 200,
  "success": true,
  "message": "Role pages retrieved",
  "data": {
    "pages": [
      {
        "id": "overview",
        "name": "Overview",
        "required": true
      },
      {
        "id": "dashboard",
        "name": "Dashboard"
      },
      {
        "id": "orders",
        "name": "Orders",
        "shopTypes": [
          "ecommerce",
          "restaurant",
          "business"
        ]
      },
      {
        "id": "inventory",
        "name": "Inventory",
        "shopTypes": [
          "ecommerce"
        ]
      }
    ]
  }
}
Returns the catalog of pages a role can grant access to for the store’s type; roles are read-only for apps. The store is bound to your app token server-side — never send a shop id.

Authorizations

​
Authorization
string
header
required

Installed-app access token (prefix app_), issued by the OAuth install flow. The store is bound to the token server-side — never send a shop id.

Response

Catalog of role pages for the store type.

Standard Salesive response envelope. The operation-specific payload is carried in data.

​
status
integer
required

HTTP status code, echoed in the body.

​
success
boolean
required

Whether the request succeeded.

​
message
string
required

Human-readable result message.

​
data
object