GET Roles (index)

Developing

GET

/api/roles

List all roles for the current tenant organization. Returns a paginated collection with permission and user counts. Supports text search across role name and description.

Permission: view roles

Request

Query Params

Header Params

Responses

🟢200Success

application/json

Bodyapplication/json

🟠401Unauthorized

🟠403Forbidden

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api-dev.commandroom.ai/api/api/roles?page=1&per_page=15&search=Admin' \
--header 'Authorization: Bearer {{token}}' \
--header 'X-Tenant-UUID: '

Response Example

200 - OK

{
  "data": [
    {
      "id": 1,
      "name": "Sample Name",
      "description": "Sample description text.",
      "guard_name": "Sample Guard Name",
      "is_default": true,
      "organization_id": 1,
      "permissions_count": 10,
      "users_count": 10,
      "permissions": [],
      "users": [],
      "created_at": "2026-01-15T10:30:00.000000Z",
      "updated_at": "2026-01-15T10:30:00.000000Z"
    }
  ],
  "links": {},
  "meta": {}
}

Modified at 2026-07-02 04:47:16

DELETE Item (destroy)

POST Roles (store)