跳转到主要内容
POST
查询成员列表

限制说明

使用说明

  • 返回 enabled 或 pending 状态的成员。已删除的成员和账户主体不会出现在列表中,可用 POST /person/infos 解析其 ID。
  • role_id 返回持有该角色的成员;member_id 最多返回该成员一人。

授权

app_key
string
query
必填

在 Flashduty 控制台 我的 → APP Key 中创建的 APP Key。可通过 query 参数 app_key 或请求头 Fd-App-Key 传入。实际可访问范围是该 APP Key 的权限范围与创建者当前角色权限的交集,请妥善保管。

请求体

application/json

查询成员列表请求

role_id
integer<uint64>

按角色 ID 过滤,角色 ID 可通过 POST /role/list 获取(内置角色:2=Admin、6=Responder、8=Viewer)

member_id
integer<uint64>

按成员 ID 过滤,仅返回该成员。

p
integer

页码,从 1 开始。默认第一页。

必填范围: x >= 1
limit
integer
默认值:100

每页条数,省略或传 0 时服务端默认 100

必填范围: 1 <= x <= 100
orderby
enum<string>

排序字段,默认 updated_at

可用选项:
created_at,
updated_at
asc
boolean

是否升序,默认 false(降序)

query
string

搜索关键字。对成员名称或邮箱做子串匹配;纯数字关键字还会精确匹配成员 ID;能解析为手机号的关键字(不带 + 时按中国号码解析)还会精确匹配手机号。

响应

成功

成功响应结构。2xx 响应中 request_id 标识本次调用(同时出现在 Flashcat-Request-Id 响应头中),data 为接口业务 payload。失败响应使用不同结构,参见 ErrorResponse。

request_id
string
必填

本次请求的唯一 ID,也会在 Flashcat-Request-Id 响应头中返回。反馈问题时请一并附上。

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

成员列表响应