Skip to main content
POST
/
role
/
list
List roles
curl --request POST \
  --url 'https://api.flashcat.cloud/role/list?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "orderby": "created_at",
  "asc": false
}
'
{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "total": 3,
    "items": [
      {
        "role_id": 2,
        "role_name": "Account Admin",
        "description": "",
        "status": "enabled",
        "permission_ids": [],
        "editable": false,
        "created_at": 1700000000,
        "updated_at": 1700000000
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.flashcat.cloud/llms.txt

Use this file to discover all available pages before exploring further.

Restrictions

AspectValue
Rate limits1,000 requests/minute; 50 requests/second per account
PermissionsNone — any valid app_key can call this operation

Usage

  • Built-in roles (editable: false) cannot be modified or deleted.

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 roles.

orderby
enum<string>

Sort field.

Available options:
created_at,
updated_at
asc
boolean

Ascending sort order.

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

Role list result.