Skip to main content
GET
/
roles
List roles
curl --request GET \
  --url https://api.salesive.com/api/v1/roles \
  --header 'Authorization: Bearer <token>'
{
  "status": 200,
  "success": true,
  "message": "Roles retrieved",
  "data": {
    "roles": [
      {
        "_id": "66b1f0a3c2d4e5f6a7b8c9d0",
        "name": "Store Manager",
        "shop": "6680aabbccddeeff00112200",
        "pages": [
          {
            "id": "overview",
            "name": "Overview",
            "required": true
          },
          {
            "id": "orders",
            "name": "Orders",
            "shopTypes": [
              "ecommerce",
              "restaurant",
              "business"
            ]
          }
        ],
        "permissions": [
          "orders:view",
          "orders:manage"
        ],
        "active": true,
        "createdAt": "2026-01-10T09:00:00.000Z",
        "updatedAt": "2026-05-02T11:30:00.000Z"
      }
    ],
    "pagination": {
      "total": 1,
      "page": 1,
      "limit": 10,
      "pages": 1,
      "hasNext": false,
      "hasPrev": false,
      "nextPage": null,
      "prevPage": null
    }
  }
}
Returns the store’s staff roles with their pages and permissions; 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.

Query Parameters

​
page
integer
default:1

Page number (1-based).

Required range: x >= 1
​
limit
integer
default:10

Number of roles per page.

Required range: x >= 1
​
search
string

Case-insensitive filter on the role name.

Response

Paginated list of staff roles.

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