OpenMax
Free Trial

Apps API · Roles

Roles: 1 endpoints

← All groups

GET /api/v1/roles

List available roles

Scope: org:role:read · Called with: appToken · operationId: list-roles

Required app scope: org:role:read.

Returns roles available for assignment. Use it when updating a member's role via PATCH /api/v1/members/{member_id} with role_id (single-role model). Supports filtering by scope (org or workspace). Requires org membership (any role).

Parameters

Name In Type Required Description
page query integer (int32) Page number (default: 1)
page_size query integer (int32) Items per page (default: 20, max: 100)
order_by query string Sort expression, e.g. created_at:desc
scope query string: org, workspace Filter by role scope: org or workspace. Omit for all roles.

Responses