获取组织信息¶

GET /api/v5/orgs/{org}

该接口用于按组织路径获取单个组织的详细信息，返回组织名称、登录名、头像、描述、所属企业、仓库、动态、成员等关联地址，以及关注数和 Gitee 关联关注数。

访问令牌支持说明¶

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

是否允许匿名访问¶

此接口允许匿名访问

请求参数¶

参数名	位置	类型	必填	说明
`org`	path	string	是	组织的路径(path/login)

响应参数¶

字段	类型	必返	可为空	说明
`id`	integer	是	否	组织 id
`login`	string	是	否	组织登录名（组织的地址 path）
`name`	string	是	否	组织名称
`avatar_url`	string	是	是	组织头像地址，可能为空
`repos_url`	string	是	否	组织仓库列表地址
`events_url`	string	是	否	组织动态地址
`members_url`	string	是	否	组织成员地址
`description`	string	是	是	组织描述，可能为空
`enterprise`	string	是	是	所属企业，可能为空
`follow_count`	integer	是	否	关注数
`gitee`	object	是	否	gitee 关联信息

gitee 对象

字段	类型	必返	可为空	说明
`gitee.follows`	integer	是	否	gitee 关注数

失败响应¶

401 未认证

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

404 组织不存在

{
  "error": "not_found",
  "message": "组织不存在"
}

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

HTTP 响应状态码¶

状态码	说明
`200`	成功（OK）
`401`	需要认证（Requires authentication）
`403`	禁止访问（Forbidden）
`404`	组织不存在（Not found）

请求示例¶

参数说明¶

<org> 替换为组织路径（企业、组织或个人的地址 path）。本接口允许匿名访问，也可携带 access_token（追加在 URL 查询参数中）。

cURL¶

curl -X GET 'https://api.atomgit.com/api/v5/orgs/<org>' \
  -H 'Accept: application/json'

JavaScript¶

// 原生 fetch (Node.js 18+ / 浏览器)
const response = await fetch("https://api.atomgit.com/api/v5/orgs/<org>", {
  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/orgs/<org>",
    headers={"Accept": "application/json"},
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例¶

状态码： 200

{
  "id": 6486504,
  "login": "openharmony",
  "name": "OpenHarmony",
  "avatar_url": "",
  "repos_url": "https://api.atomgit.com/openharmony/repos",
  "events_url": "https://api.atomgit.com/openharmony/events",
  "members_url": "https://api.atomgit.com/openharmony/members{/member}",
  "description": "OpenHarmony是由开放原子开源基金会（OpenAtom Foundation）孵化及运营的开源项目，目标是面向全场景、全连接、全智能时代，搭建一个智能终端设备操作系统的框架和平台，促进万物互联产业的繁荣发展。",
  "enterprise": "openharmony",
  "follow_count": 40819,
  "gitee": {
    "follows": 43454
  }
}

错误码¶

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

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