开发者文档

成员分组列表

GET/api/orgs/:orgId/groups

权限与前置条件

当前有效工作区成员;工作区及账号必须有效。

支持账号中心 API Key:Authorization: Bearer <ltak_…>。中心每次实时校验,仍执行当前用户的工作区角色和业务权限。Cookie 写入仍需允许来源的 Origin 和 X-Requested-With: suren360。不能同时携带 Cookie 与 API Key。所有路径参数须使用真实 ID。

请求参数

orgId · 路径参数 · 必填字符串

Query 查询参数

字段类型必填约束
pageinteger否{"default":1,"minimum":1,"maximum":9007199254740991}
pageSizeinteger否{"default":20,"minimum":1,"maximum":100}
qstring否{"default":"","maxLength":100}
minestring否{"default":"false","enum":["true","false"]}
查看完整请求 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
    },
    "mine": {
      "default": "false",
      "type": "string",
      "enum": [
        "true",
        "false"
      ]
    }
  }
}

调用示例

先在统一账号中心创建 Key,并授权素人种草 360 应用,将密钥安全设置为 LINGTU_API_KEY 环境变量。 请替换部署地址与示例字段,不要将凭证粘贴到聊天或日志中。

cURL · 示例占位值需替换
curl --request GET \
  'https://YOUR_DEPLOYMENT_HOST/api/orgs/YOUR_orgId/groups' \
  --header "Authorization: Bearer $LINGTU_API_KEY"

响应结构

成功返回 HTTP 200 的 JSON 对象。下方为响应结构定义,不是虚构的业务数据。

字段类型必填约束
itemsarray是{}
totalinteger是{"minimum":-9007199254740991,"maximum":9007199254740991}
pageinteger是{"minimum":-9007199254740991,"maximum":9007199254740991}
pageSizeinteger是{"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": {
          "isDefault": {
            "type": "boolean"
          },
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "leaderUserId": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "leaderName": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "leaderStatus": {
            "anyOf": [
              {
                "type": "string",
                "enum": [
                  "active",
                  "suspended"
                ]
              },
              {
                "type": "null"
              }
            ]
          },
          "memberCount": {
            "type": "integer",
            "minimum": -9007199254740991,
            "maximum": 9007199254740991
          },
          "creatorCount": {
            "type": "integer",
            "minimum": -9007199254740991,
            "maximum": 9007199254740991
          },
          "myRole": {
            "anyOf": [
              {
                "type": "string",
                "enum": [
                  "leader",
                  "member"
                ]
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "id",
          "name",
          "description",
          "leaderUserId",
          "leaderName",
          "leaderStatus",
          "memberCount",
          "creatorCount",
          "myRole"
        ],
        "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
}
查看错误码与重试规则