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 Vista previa 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).
Tokens de acceso granulares para "List planning statuses for a repository"
Este punto de conexión funciona con los siguientes tipos de token pormenorizados:
- tokens de acceso de usuario de la aplicación de GitHub
- Token de acceso a la instalación de la aplicación de GitHub
- Tokens de acceso personal específico
El token pormenorizado debe tener el siguiente conjunto de permisos:
- "Issues" repository permissions (read)
Este punto de conexión se puede usar sin autenticación o los permisos mencionados anteriormente si solo se solicitan recursos públicos.
Parámetros para "List planning statuses for a repository"
| Nombre, Tipo, Descripción |
|---|
accept string Setting to |
| Nombre, Tipo, Descripción |
|---|
owner string ObligatorioThe account owner of the repository. The name is not case sensitive. |
repo string ObligatorioThe name of the repository without the |
Códigos de estado de respuesta HTTP para "List planning statuses for a repository"
| código de estado | Descripción |
|---|---|
200 | Available planning statuses in display order |
404 | Resource not found |
Ejemplos de código para "List planning statuses for a repository"
Si accede a GitHub en GHE.com, reemplace api.github.com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.
Ejemplo de solicitud
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"
}
]