Skip to main content

List Roles

List roles in the organization.

Outline

Endpoint

GET /api/v1/roles?skip=0&limit=100

Headers

HeaderRequiredDescription
AuthorizationYesBearer <access_token>

Query Parameters

ParameterTypeRequiredDescription
skipintegerNoNumber of records to skip (default: 0)
limitintegerNoMaximum records to return (default: 100)

Response

Success (200)

{
"success": true,
"data": {
"roles": [
{
"id": 1,
"name": "Admin",
"permissions": ["*"],
"usage_count": 10
}
],
"total_count": 5,
"message": "Roles listed successfully"
},
"message": "Roles listed successfully"
}

Features

  • Role listing with pagination
  • Permission summary
  • Usage statistics

Status

[WARNING] TODO: Not Implemented

This endpoint is defined in the router but the implementation logic is not yet complete.