Skip to main content

List Roles

List all roles for the given organization.

Outline

Endpoint

GET /api/v1/organizations/{org_id}/roles

Headers

HeaderRequiredDescription
AuthorizationYesBearer <access_token>

Path Parameters

ParameterTypeRequiredDescription
org_idintegerYesOrganization ID

Response

Success (200)

{
"success": true,
"data": {
"roles": [
{
"id": 1,
"name": "Admin",
"permissions": ["*"]
},
{
"id": 2,
"name": "Developer",
"permissions": ["workspace.read", "workspace.write"]
},
{
"id": 3,
"name": "Viewer",
"permissions": ["workspace.read"]
}
],
"total_count": 3,
"message": "Roles retrieved successfully"
},
"message": "Roles retrieved successfully"
}

Permissions

  • System admin: can list all roles
  • Org owner: can list all roles in their organization
  • Org admin: can list all roles in their organization

Features

  • Return all roles within the organization
  • Require authentication
  • Validate organization access permissions