跳转至

获取当前用户某个组织的Issues

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

该接口用于获取当前用户指定组织的 Issue 列表,支持按负责或创建来源、开启或关闭状态、标签、创建时间等条件筛选,并可按创建或更新时间排序、分页返回,同时支持关键字搜索标题或内容。

访问令牌支持说明

  • AtomGit 用户访问令牌(AtomGit user access tokens)

是否允许匿名访问

此接口不允许匿名访问

请求参数

参数名 位置 类型 必填 说明
org path string 是 组织的路径(path/login)
access_token query string 是 用户授权码
filter query string 否 筛选参数:授权用户负责的(assigned),授权用户创建的(created),包含前两者的(all)。默认 assigned
state query string 否 Issue 的状态:open(开启的)、closed(关闭的),默认 open
labels query string 否 用逗号分开的标签,如 bug,performance
sort query string 否 排序依据:创建时间(created)、更新时间(updated_at),默认 created_at
direction query string 否 排序方式:升序(asc)、降序(desc),默认 desc
page query integer 否 当前的页码
per_page query integer 否 每页数量,最大 100,默认 20
created_at query string 否 任务创建时间
search query string 否 通过关键字搜索 Issue 标题或内容

响应参数

响应体为 Issue 对象的数组,数组元素包含以下字段:

字段 类型 必返 可为空 说明
id integer 是 否 Issue ID
html_url string 是 否 Issue 的 HTML 链接
number string 是 否 Issue 编号
state string 是 否 Issue 状态
title string 是 否 标题
body string 是 否 内容
user object 是 否 创建者
assignee object 是 否 负责人
repository object 是 否 所属仓库
created_at string 是 否 创建时间
updated_at string 是 否 更新时间
finished_at string 是 否 完成时间
deadline string 是 否 截止时间
labels object[] 是 否 标签列表
issue_state string 是 否 Issue 状态
comments integer 是 否 评论数
priority integer 是 否 优先级
issue_type string 是 否 Issue 类型
issue_state_detail object 是 否 状态详情
issue_type_detail object 是 否 类型详情
issue_priority_detail object 否 是 Issue 优先级详情
parent_id integer 是 否 父 Issue ID
url string 是 否 Issue 的 API 链接
repository_url string 是 否 所属仓库的 API 链接
milestone object 否 是 里程碑
visibility_reason string 否 是 可见性:public:公开可见,confidential:私密,项目成员可见,other:其他原因导致的仅项目成员可见

user 对象

字段 类型 必返 可为空 说明
user.id string 是 否 用户 ID
user.login string 是 否 登录名
user.name string 是 否 用户名

assignee 对象

字段 类型 必返 可为空 说明
assignee.avatar_url string 是 否 头像链接
assignee.html_url string 是 否 用户主页链接
assignee.id string 是 否 用户 ID
assignee.login string 是 否 登录名
assignee.name string 是 否 用户名
assignee.type string 是 否 用户类型

repository 对象

字段 类型 必返 可为空 说明
repository.id integer 是 否 仓库 ID
repository.full_name string 是 否 完整名称(namespace/name)
repository.human_name string 是 否 展示名称
repository.path string 是 否 仓库路径
repository.name string 是 否 仓库名
repository.url string 是 否 仓库链接
repository.assigner object 是 否 指派者,以实际返回为准
repository.paas string 是 否 平台即服务标识

labels 数组元素

字段 类型 必返 可为空 说明
labels.id integer 是 否 标签 ID
labels.name string 是 否 标签名
labels.color string 是 否 标签颜色

issue_state_detail 对象

字段 类型 必返 可为空 说明
issue_state_detail.title string 是 否 状态名称
issue_state_detail.serial integer 是 否 排序号
issue_state_detail.id integer 否 是 状态 ID

issue_type_detail 对象

字段 类型 必返 可为空 说明
issue_type_detail.title string 是 否 类型名称
issue_type_detail.id integer 是 否 类型 ID
issue_type_detail.is_system boolean 是 否 是否为系统内置类型

issue_priority_detail 对象

字段 类型 必返 可为空 说明
issue_priority_detail.id string 是 否 优先级 ID
issue_priority_detail.title string 是 否 优先级名称

milestone 对象

字段 类型 必返 可为空 说明
milestone.created_at string 是 否 创建时间
milestone.description string 是 否 描述
milestone.due_on string 是 否 截止时间
milestone.html_url string 是 否 里程碑 HTML 链接
milestone.number integer 是 否 编号
milestone.repository_id integer 是 否 仓库 ID
milestone.state string 是 否 状态
milestone.title string 是 否 标题
milestone.updated_at string 是 否 更新时间
milestone.url string 是 否 里程碑链接

失败响应

401 未认证

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

HTTP 响应状态码

状态码 说明
200 成功(OK)
401 需要认证(Requires authentication)
403 禁止访问(Forbidden)
404 请求路径不存在
429 请求过于频繁,触发限流
500 系统内部错误

请求示例

参数说明

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

cURL

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

JavaScript

// 原生 fetch (Node.js 18+ / 浏览器)
const response = await fetch(
  "https://api.atomgit.com/api/v5/orgs/<org>/issues?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

resp = requests.get(
    "https://api.atomgit.com/api/v5/orgs/<org>/issues",
    params={"access_token": "<token>"},
    headers={"Accept": "application/json"},
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例

状态码: 200

[
  {
    "id": 495900,
    "html_url": "https://api.atomgit.com/Go-Tribe/test01/issues/1",
    "number": "1",
    "state": "open",
    "title": "示例 Issue",
    "body": "Issue 描述",
    "user": {
      "id": "650d67fbae6d795139b49b41",
      "login": "dengmengmian",
      "name": "麻凡"
    },
    "assignee": {
      "avatar_url": "https://api.atomgit.com/avatar.png",
      "html_url": "https://api.atomgit.com/Go-Tribe/test01/issues/1",
      "id": "650d67fbae6d795139b49b41",
      "login": "dengmengmian",
      "name": "麻凡",
      "type": "user"
    },
    "repository": {
      "id": 4016571,
      "full_name": "Go-Tribe/test01",
      "human_name": "gotribe / test01",
      "path": "test01",
      "name": "test01",
      "url": "https://api.atomgit.com/Go-Tribe/test01",
      "assigner": {},
      "paas": ""
    },
    "created_at": "2024-10-12T18:27:27+08:00",
    "updated_at": "2024-10-12T18:27:27+08:00",
    "finished_at": "2024-10-12T18:27:27+08:00",
    "deadline": "2024-10-20T00:00:00+08:00",
    "labels": [
      {
        "id": 1,
        "name": "bug",
        "color": "#ee0701"
      }
    ],
    "issue_state": "open",
    "comments": 0,
    "priority": 0,
    "issue_type": "task",
    "issue_state_detail": {
      "title": "待处理",
      "serial": 1,
      "id": 1
    },
    "issue_type_detail": {
      "title": "任务",
      "id": 1,
      "is_system": true
    },
    "issue_priority_detail": {
      "id": "2",
      "title": "普通"
    },
    "parent_id": 0,
    "url": "https://api.atomgit.com/Go-Tribe/test01/issues/1",
    "repository_url": "https://api.atomgit.com/Go-Tribe/test01",
    "milestone": {
      "created_at": "2024-10-01T10:00:00+08:00",
      "description": "里程碑描述",
      "due_on": "2024-11-01T00:00:00+08:00",
      "html_url": "https://api.atomgit.com/Go-Tribe/test01/milestones/1",
      "number": 1,
      "repository_id": 4016571,
      "state": "open",
      "title": "v1.0",
      "updated_at": "2024-10-01T10:00:00+08:00",
      "url": "https://api.atomgit.com/Go-Tribe/test01/milestones/1"
    },
    "visibility_reason": "public"
  }
]

错误码

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

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