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 Vorschau 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).
Feinkörnige Zugriffstoken für "List planning statuses for a repository"
Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:
- GitHub App-Benutzerzugriffstoken
- GitHub-App-Installations-Zugriffstoken
- Feingranulare persönliche Zugriffstoken
Das differenzierte Token muss über den folgenden Berechtigungssatz verfügen.:
- "Issues" repository permissions (read)
Dieser Endpunkt kann ohne Authentifizierung oder die zuvor erwähnten Berechtigungen verwendet werden, wenn nur öffentliche Ressourcen angefordert werden.
Parameter für "List planning statuses for a repository"
| Name, Typ, BESCHREIBUNG |
|---|
accept string Setting to |
| Name, Typ, BESCHREIBUNG |
|---|
owner string ErforderlichThe account owner of the repository. The name is not case sensitive. |
repo string ErforderlichThe name of the repository without the |
HTTP-Antwortstatuscodes für "List planning statuses for a repository"
| Statuscode | BESCHREIBUNG |
|---|---|
200 | Available planning statuses in display order |
404 | Resource not found |
Codebeispiele für "List planning statuses for a repository"
Anforderungsbeispiel
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"
}
]