Skip to main content
POST
List permissions

Restrictions

Usage

  • Pass role_ids to filter permissions to those granted to those roles.
  • Pass with_all: true to include all permissions regardless of role filter, with is_granted set to indicate which are granted to the specified roles.

Authorizations

app_key
string
query
required

App key issued from the Flashduty console under Account → APP Keys. Required on every public API call. Keep it secret — it grants the same access as the owning account.

Body

application/json

Filters for listing permissions.

role_ids
integer<uint64>[]

Filter to permissions granted to these roles.

with_all
boolean

If true, return all permissions with is_granted set to indicate which are granted.

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
required

Permission list result.