跳转到主要内容
POST
查询协作空间列表

限制说明

使用说明

  • 不加过滤条件时返回账户内全部协作空间,但不包含调用者无权访问的私有协作空间。已删除的协作空间不会返回。
  • is_my_team 与 is_my_starred 同时为 true 时返回 InvalidParameter。is_my_managed 优先于这两者。使用 is_my_managed 或 is_my_team 时忽略 team_ids。
  • is_brief: true 时每项只含 channel_id、channel_name、description、status、is_starred,并一次返回全部结果。
  • 请始终传入 p。不传时虽然返回第一页,但只要有结果 has_next_page 就恒为 true。

授权

app_key
string
query
必填

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

请求体

application/json
p
integer

页码,从 1 开始。请始终传入:不传时返回第一页,但 has_next_page 不可靠。

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

每页大小,未传时默认为 100。

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

排序字段,默认 created_at。ranking 按调用者在控制台保存的自定义顺序排序,未保存时按创建顺序;channel_name 不区分大小写排序。

可用选项:
ranking,
created_at,
updated_at,
channel_name,
last_incident_at
asc
boolean

为 true 时升序排列;默认为 false(降序)。

is_my_managed
boolean

为 true 时只返回所属团队为调用者所在团队、或由调用者创建的协作空间。优先于 is_my_team 与 is_my_starred。

is_my_starred
boolean

为 true 时只返回调用者收藏的协作空间。不能与 is_my_team 同时为 true。

is_brief
boolean

为 true 时每项只返回 channel_id、channel_name、description、status、is_starred,并一次返回全部结果。

is_my_team
boolean

为 true 时只返回所属团队为调用者所在团队的协作空间。不能与 is_my_starred 同时为 true。

team_ids
integer<int64>[]

只返回所属团队在列表中的协作空间。is_my_managed 或 is_my_team 为 true 时忽略。

query
string

针对协作空间名称和描述的不区分大小写正则匹配;正则语法非法时按字面量匹配。必须为合法 UTF-8,非法字节序列会返回 InvalidParameter。

channel_ids
integer<int64>[]

按指定协作空间 ID 过滤。

channel_name
string

协作空间名称精确匹配,优先级高于 query 的名称过滤。必须为合法 UTF-8,非法字节序列会返回 InvalidParameter。

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

接口返回的数据,格式见各接口的 200 响应。没有返回数据的接口会返回 {} 或完全不带 data。