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 prévia 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 acesso granulares para "List planning statuses for a repository"

Este endpoint funciona com os seguintes tipos de token granulares:

O token refinado deve ter os seguintes conjuntos de permissões:

  • "Issues" repository permissions (read)

Esse endpoint pode ser usado sem autenticação ou permissões mencionadas acima, se apenas recursos públicos forem solicitados.

Parâmetros para "List planning statuses for a repository"

Cabeçalhos
Nome, Tipo, Descrição
accept string

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

Parâmetros de caminho
Nome, Tipo, Descrição
owner string Obrigatório

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

repo string Obrigatório

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

Códigos de status de resposta HTTP para "List planning statuses for a repository"

Código de statusDescrição
200

Available planning statuses in display order

404

Resource not found

Exemplos de código para "List planning statuses for a repository"

Se você acessar GitHub em GHE.com, substitua api.github.com pelo subdomínio dedicado da sua empresa em api.SUBDOMAIN.ghe.com.

Exemplo de solicitação

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