Skip to main content
POST
List members

Restrictions

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

List members request

role_id
integer<uint64>

Filter by role ID. Get role IDs from POST /role/list (built-in roles: 2=Admin, 6=Responder, 8=Viewer)

p
integer

Page number, 1-based

Required range: x >= 1
limit
integer
default:100

Page size. Defaults to 100 on the server when omitted or 0

Required range: 1 <= x <= 100
orderby
enum<string>

Sort field. Default: updated_at

Available options:
created_at,
updated_at
asc
boolean

Ascending order. Default: false (descending)

query
string

Substring match on member name or email; if the keyword parses as a phone number, an exact phone match is also applied

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

Member list response