列出组织的所有成员¶

GET /api/v5/orgs/{org}/members

该接口用于获取指定组织的全部成员列表，支持分页查询，并可依据成员角色（管理员或普通成员）进行筛选，返回成员的头像、昵称、登录名及角色等详细信息。

访问令牌支持说明¶

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

是否允许匿名访问¶

此接口不允许匿名访问

请求参数¶

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

请求示例¶

参数说明¶

示例中的占位符说明：

<org> 替换为组织路径名（企业、组织或个人的地址 path）； <token> 替换为你的 AtomGit 用户访问令牌。

cURL¶

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

JavaScript¶

// 原生 fetch (Node.js 18+ / 浏览器)
const org = "<org>";
const token = "<token>";

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

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

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

Python¶

import requests

org = "<org>"
token = "<token>"

resp = requests.get(
    f"https://api.atomgit.com/api/v5/orgs/{org}/members",
    params={
        "page": 1,
        "per_page": 20,
        "role": "admin",
        "access_token": token,
    },
    headers={
        "Accept": "application/json",
    },
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应参数¶

字段	类型	必返	可为空	说明
`avatar_url`	string	否	是	头像地址
`followers_url`	string	否	是	粉丝列表地址
`html_url`	string	否	是	用户主页地址
`id`	string	否	是	用户 id
`login`	string	否	是	登录名
`member_role`	string	否	是	成员角色
`name`	string	否	是	用户昵称
`type`	string	否	是	用户类型（如 `User`）
`url`	string	否	是	API 地址
`user_id`	string	否	是	用户 id
`object_id`	string	否	是	对象 id

Note: 响应体为成员对象数组，上表为每个数组元素的字段。

失败响应¶

调用方需要知道失败时的响应形态，以便编写错误处理。

401 未认证

{
  "error": "unauthorized",
  "message": "缺少或无效的访问令牌"
}

错误字段名以后端实际返回为准。

HTTP 响应状态码¶

状态码	说明
`200`	成功（OK）
`401`	需要认证（Requires authentication）
`403`	禁止访问（Forbidden）

响应示例¶

状态码： 200

[
  {
    "avatar_url": "https://cdn-img.atomgit.com/ec/fb/430ecf07b9ee91bbbbf341d92a36783d06e69086f82ce8cf5a6406f79f1c9cf4.png",
    "followers_url": "https://api.atomgit.com/api/v5/users/dengmengmian/followers",
    "html_url": "https://api.atomgit.com/dengmengmian",
    "id": "268",
    "login": "dengmengmian",
    "member_role": "admin",
    "name": "麻凡",
    "type": "User",
    "url": "https://api.atomgit.com/api/v5/dengmengmian",
    "user_id": "268",
    "object_id": "8f9d2c1e0a4b7c3d9e2f1a6b"
  }
]

错误码¶

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

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