List roles

Returns all roles visible to the caller, scoped by data access control.

GET /api/roles

Error

A valid request URL is required to generate request examples

200

{
  "roles": [
    {
      "id": 123,
      "name": "<string>",
      "description": "<string>",
      "is_system_role": true,
      "created_by_user_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

Authorization · string · header · required

Management API authentication for /api/* endpoints. Use the Authorization header with Bearer <API key>. Virtual keys, dashboard/user/session tokens, and x-api-key headers are not supported on management APIs.

Response

200

application/json

Successful response

roles · object[]

Show child attributes