Skip to main content
POST
List roles

Restrictions

Usage

  • Custom roles (enabled and disabled) come first, sorted by orderby/asc; the three built-in roles — 2 Admin, 6 Responder, 8 Viewer — are appended at the end unless no_global is true, and are counted in total.
  • Built-in roles have editable: false, and their description follows the request language (Accept-Language header, or the locale/lang query parameter).

Authorizations

app_key
string
query
required

APP Key created in the Flashduty console under My → APP Key. Send it as the app_key query parameter or in the Fd-App-Key request header. Its effective access is the intersection of the key's permission scope and the creator's current role permissions. Keep it secret.

Body

application/json

Filters for listing roles.

orderby
enum<string>

Sort field. Default: updated_at.

Available options:
created_at,
updated_at
asc
boolean

Ascending sort order. Default: false (descending).

no_global
boolean

When true, exclude the built-in global roles (Admin, Responder, Viewer) and return only custom roles. Default: false.

Response

Success

Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.

request_id
string
required

Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

Role list result.