Documentation

Roles

List all roles

Returns all roles with user count and permissions.

ProductionStagingUAT
GEThttps://ankiren.com/api/admin/roles

Responses

200 · List of roles

  • roles[RoleWithDetails]
    • idstring
    • namestring
    • descriptionstring
    • isSystemboolean
    • createdAtstring<date-time>
      format: date-time
    • updatedAtstring<date-time>
      format: date-time
    • userCountinteger
    • permissions[string]
application/json
{
  "roles": [
    {
      "id": "role_admin",
      "name": "admin",
      "description": "System administrator with full access",
      "isSystem": true,
      "createdAt": "2025-01-01T00:00:00Z",
      "updatedAt": "2025-01-01T00:00:00Z",
      "userCount": 1,
      "permissions": [
        "users:manage",
        "roles:manage"
      ]
    }
  ]
}

Sample Code

Đổi ngôn ngữ ở ô Language trên thanh Documentation.

cURL
curl -X GET 'https://ankiren.com/api/admin/roles' \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept: application/json'