Skip to main content
GET
List roles
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

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