开发者文档
邀请列表
GET
/api/orgs/:orgId/invitations权限与前置条件
工作区所有者或管理员;受业务状态及交接规则约束。
此接口仅支持浏览器登录,不接受 API Key。Cookie 写入仍需允许来源的 Origin 和 X-Requested-With: suren360。不能同时携带 Cookie 与 API Key。所有路径参数须使用真实 ID。
请求参数
orgId · 路径参数 · 必填字符串
Query 查询参数
| 字段 | 类型 | 必填 | 约束 |
|---|---|---|---|
page | integer | 否 | {"default":1,"minimum":1,"maximum":9007199254740991} |
pageSize | integer | 否 | {"default":20,"minimum":1,"maximum":100} |
q | string | 否 | {"default":"","maxLength":100} |
查看完整请求 JSON Schema
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"page": {
"default": 1,
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"pageSize": {
"default": 20,
"type": "integer",
"minimum": 1,
"maximum": 100
},
"q": {
"default": "",
"type": "string",
"maxLength": 100
}
}
}调用示例
先通过浏览器统一登录,使用受控环境中的已有会话。 请替换部署地址与示例字段,不要将凭证粘贴到聊天或日志中。
cURL · 示例占位值需替换
curl --request GET \
'https://YOUR_DEPLOYMENT_HOST/api/orgs/YOUR_orgId/invitations' \
--cookie "$SUREN360_COOKIE"响应结构
成功返回 HTTP 200 的 JSON 对象。下方为响应结构定义,不是虚构的业务数据。
| 字段 | 类型 | 必填 | 约束 |
|---|---|---|---|
items | array | 是 | {} |
total | integer | 是 | {"minimum":-9007199254740991,"maximum":9007199254740991} |
page | integer | 是 | {"minimum":-9007199254740991,"maximum":9007199254740991} |
pageSize | integer | 是 | {"minimum":-9007199254740991,"maximum":9007199254740991} |
查看完整响应 JSON Schema
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"createdById": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
"expiresAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
"revokedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
{
"type": "null"
}
]
},
"usedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
{
"type": "null"
}
]
},
"usedById": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"createdById",
"createdAt",
"expiresAt",
"revokedAt",
"usedAt",
"usedById"
],
"additionalProperties": false
}
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"pageSize": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"items",
"total",
"page",
"pageSize"
],
"additionalProperties": false
}