Skip to main content
Skip to content

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 aperçu 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).

Jetons d'accès granulaires pour «List planning statuses for a repository»

Ce point de terminaison fonctionne avec les types de tokens à granularité fine suivants:

Le token à granularité fine doit disposer de l’ensemble d’autorisations suivant:

  • "Issues" repository permissions (read)

Ce point de terminaison peut être utilisé sans authentification ou sans les autorisations mentionnées ci-dessus si seules les ressources publiques sont demandées.

Paramètres pour «List planning statuses for a repository »

En-têtes
Nom, Type, Description
accept string

Setting to application/vnd.github+json is recommended.

Paramètres de chemin d’accès
Nom, Type, Description
owner string Requis

The account owner of the repository. The name is not case sensitive.

repo string Requis

The name of the repository without the .git extension. The name is not case sensitive.

Codes d’état de réponse HTTP pour «List planning statuses for a repository »

Code de statutDescription
200

Available planning statuses in display order

404

Resource not found

Exemples de code pour «List planning statuses for a repository »

Exemple de requête

get/repos/{owner}/{repo}/planning-statuses
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-statuses

Available 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" } ]