列出企业的所有成员¶

GET /api/v5/enterprises/{enterprise}/members

该接口用于列出指定企业的所有成员，支持按角色筛选成员，并分页返回企业成员列表，包含成员角色及用户信息。

访问令牌支持说明¶

AtomGit 用户访问令牌（AtomGit user access tokens）

是否允许匿名访问¶

此接口不允许匿名访问

请求参数¶

参数名	位置	类型	必填	说明
`enterprise`	path	string	是	企业的路径(path/login)
`access_token`	query	string	是	用户授权码
`page`	query	integer	否	当前的页码，默认 `1`
`per_page`	query	integer	否	每页的数量，最大为 `100`，默认 `30`
`role`	query	string	否	根据角色筛选成员，枚举：`all` / `admin` / `member`，默认 `all`

响应参数¶

响应体为成员对象数组，每个数组元素表示一名企业成员。

成员对象

字段	类型	必返	可为空	说明
`user`	object	是	否	成员的用户信息
`url`	string	是	否	成员详情 API URL
`active`	boolean	是	否	成员是否处于激活状态
`role`	string	是	否	成员角色，如 `admin` / `member`
`role_name`	string	是	否	角色名称
`role_id`	string	是	否	角色 ID
`role_name_cn`	string	是	否	角色中文名称

user 对象

字段	类型	必返	可为空	说明
`user.avatar_url`	string	是	否	用户头像 URL
`user.html_url`	string	是	否	用户主页 URL
`user.id`	string	是	否	用户 ID
`user.login`	string	是	否	用户登录名
`user.name`	string	是	否	用户名
`user.url`	string	是	否	用户 API URL
`user.object_id`	string	是	否	用户对象 ID
`user.user_id`	string	是	否	用户平台内部 ID

失败响应¶

400 参数错误

{
  "error_code": 400,
  "error_code_name": "PARAMETER_ERROR",
  "error_message": "page must be greater than 0",
  "trace_id": "0c9f3f4a6b..."
}

401 未认证

{
  "error_code": 401,
  "error_code_name": "UNAUTHORIZED",
  "error_message": "Unauthorized",
  "trace_id": "0c9f3f4a6b..."
}

HTTP 响应状态码¶

状态码	说明
`200`	成功（OK）
`304`	未修改（Not modified）
`401`	需要认证（Requires authentication）
`403`	禁止访问（Forbidden）
`404`	资源不存在（Not found）
`429`	请求过于频繁，触发限流（Too many requests）
`500`	系统内部错误（Internal server error）

请求示例¶

参数说明¶

<enterprise> — 替换为企业的路径（path/login），例如 go-tribe； <token> — 替换为你的 AtomGit 用户访问令牌。

cURL¶

curl -X GET 'https://api.atomgit.com/api/v5/enterprises/<enterprise>/members?access_token=<token>&page=1&per_page=20&role=all' \
  -H 'Accept: application/json'

JavaScript¶

const enterprise = "<enterprise>";
const token = "<token>";

const response = await fetch(
  `https://api.atomgit.com/api/v5/enterprises/${enterprise}/members?access_token=${token}&page=1&per_page=20&role=all`,
  {
    headers: {
      "Accept": "application/json",
    },
  }
);

if (!response.ok) {
  throw new Error(`请求失败: ${response.status}`);
}

const data = await response.json();
console.log(data);

Python¶

import requests

resp = requests.get(
    "https://api.atomgit.com/api/v5/enterprises/<enterprise>/members",
    params={
        "access_token": "<token>",
        "page": 1,
        "per_page": 20,
        "role": "all",
    },
    headers={"Accept": "application/json"},
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例¶

状态码： 200

[
  {
    "user": {
      "avatar_url": "https://api.atomgit.com/avatar/dengmengmian.png",
      "html_url": "https://api.atomgit.com/dengmengmian",
      "id": "268",
      "login": "dengmengmian",
      "name": "麻凡",
      "url": "https://api.atomgit.com/api/v5/dengmengmian",
      "object_id": "d8f1a0b2c3e4f5a6b7c8d9e0",
      "user_id": "100268"
    },
    "url": "https://api.atomgit.com/api/v5/enterprises/go-tribe/members/dengmengmian",
    "active": true,
    "role": "admin",
    "role_name": "admin",
    "role_id": "45a9-276d8e546f1b05f9f98ce1ffdc6",
    "role_name_cn": "管理员"
  }
]

错误码¶

错误码	说明
`400`	参数错误或请求无法解析
`401`	未认证或凭证无效（缺少/无效的访问凭证）
`403`	禁止访问
`404`	请求路径不存在
`429`	请求过于频繁，触发限流
`500`	系统内部错误

本页原文 Markdown：在 AtomGit 查看·内容源自开源项目 gitcode-dev/atomgit-api-doc