REST API endpoints for planning statuses
Use the REST API to list the planning statuses that issues in a repository can have. Issue statuses are in 预览 and only available to accounts enrolled in the preview.
List planning statuses for a repository
Lists the selectable planning statuses available.
Planning statuses are returned in deterministic display order:
Backlog, Todo, In progress, In review, Done, Not planned, and Duplicate.
Clients should expect new keys to be added.
Returns 404 Not Found when issue statuses aren't available in the repository.
Note
Issue statuses are in preview and subject to change. They're only available to accounts enrolled in the preview.
You need read access to the repository's issues to use this endpoint.
OAuth app tokens and personal access tokens (classic) need the repo scope
to use this endpoint with a private repository.
Fine-grained access tokens require the "Issues" repository permission (read).
“List planning statuses for a repository”的细粒度访问令牌
此端点支持以下精细令牌类型:
细粒度令牌必须具有以下权限集:
- "Issues" repository permissions (read)
如果仅请求公共资源,则无需身份验证或上述权限即可使用此终结点。
“”List planning statuses for a repository 的参数
| 名称, 类型, 说明 |
|---|
accept string Setting to |
| 名称, 类型, 说明 |
|---|
owner string 必须The account owner of the repository. The name is not case sensitive. |
repo string 必须The name of the repository without the |
“List planning statuses for a repository”的 HTTP 响应状态代码
| 状态代码 | 说明 |
|---|---|
200 | Available planning statuses in display order |
404 | Resource not found |
“List planning statuses for a repository”的代码示例
如果你在 GHE.com 上访问 GitHub,请将 api.github.com 替换为企业的专用子域,位于 api.SUBDOMAIN.ghe.com。
请求示例
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2026-03-10" \
https://api.github.com/repos/OWNER/REPO/planning-statusesAvailable planning statuses in display order
Status: 200[
{
"id": 2,
"name": "Backlog",
"category": "backlog"
},
{
"id": 3,
"name": "Todo",
"category": "planned"
},
{
"id": 4,
"name": "In progress",
"category": "started"
},
{
"id": 8,
"name": "In review",
"category": "started"
},
{
"id": 5,
"name": "Done",
"category": "completed"
},
{
"id": 6,
"name": "Not planned",
"category": "not_planned"
},
{
"id": 7,
"name": "Duplicate",
"category": "duplicate"
}
]