GIgithub
repos

List planning statuses for a repository

Changed on

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).

get/repos/{owner}/{repo}/planning-statuses

Request

  • Base URL
    https://api.github.com
  • Auth
    none declared

Path parameters

ownerstring required

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

repostring required

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

Response

Available planning statuses in display order

idinteger required

The stable identifier of the planning status.

namestring required

The display name of the planning status, which may change in the future.

categorystring required

A stable identifier for the category, such as backlog, planned, started, completed, not_planned or duplicate. Clients should expect new keys to be added.

Example response

[
  {
    "id": 4,
    "name": "In progress",
    "category": "started"
  }
]

Changes