Skip to main content
POST
List members

Restrictions

Usage

  • Returns members in enabled or pending status. Removed members and the account owner are not listed; resolve their IDs with POST /person/infos.
  • role_id returns the members holding that role; member_id returns at most that one member.

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

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)

member_id
integer<uint64>

Filter by member ID. Return only the member with this ID.

p
integer

Page number, starting at 1. Defaults to the first page.

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

Keyword. Matches a substring of the member name or email; a numeric keyword also matches an exact member ID, and a keyword that parses as a phone number (without +, parsed as a Chinese number) also matches the exact phone.

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

Member list response