REST API endpoints for issue types

Use the REST API to create and manage issue types for the authenticated user.

List issue types

Lists all issue types for the authenticated user. OAuth app tokens and personal access tokens (classic) need the read:user scope to use this endpoint.

Tokens de acesso granulares para "List issue types"

Este endpoint funciona com os seguintes tipos de token granulares:

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

  • "Issue Types" user permissions (read)

Códigos de status de resposta HTTP para "List issue types"

Código de statusDescrição
200

OK

404

Resource not found

Exemplos de código para "List issue types"

Exemplo de solicitação

get/user/issue-types
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/user/issue-types

Response

Status: 200
[ { "id": 410, "node_id": "IT_kwDNAd3NAZo", "name": "Task", "description": "A specific piece of work", "created_at": "2024-12-11T14:39:09Z", "updated_at": "2024-12-11T14:39:09Z" }, { "id": 411, "node_id": "IT_kwDNAd3NAZs", "name": "Bug", "description": "An unexpected problem or behavior", "created_at": "2024-12-11T14:39:09Z", "updated_at": "2024-12-11T14:39:09Z" } ]

Create an issue type

Creates a new issue type for the authenticated user's personal account.

OAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.

Tokens de acesso granulares para "Create an issue type"

Este endpoint funciona com os seguintes tipos de token granulares:

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

  • "Issue Types" user permissions (write)

Parâmetros para "Create an issue type"

Cabeçalhos
accept string

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

Parâmetros do corpo
name string Obrigatório

Name of the issue type.

is_enabled boolean Obrigatório

Whether or not the issue type is enabled.

description string or null

Description of the issue type.

color string or null

Color for the issue type.

Pode ser um dos: gray, blue, green, yellow, orange, red, pink, purple, null

Códigos de status de resposta HTTP para "Create an issue type"

Código de statusDescrição
200

OK

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

Exemplos de código para "Create an issue type"

Exemplo de solicitação

post/user/issue-types
curl -L \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2026-03-10" \ https://api.github.com/user/issue-types \ -d '{"name":"Epic","description":"An issue type for a multi-week tracking of work","is_enabled":true,"color":"green"}'

Response

Status: 200
{ "id": 410, "node_id": "IT_kwDNAd3NAZo", "name": "Task", "description": "A specific piece of work", "created_at": "2024-12-11T14:39:09Z", "updated_at": "2024-12-11T14:39:09Z" }

Update an issue type

Updates an issue type for the authenticated user.

The authenticated user must own the issue type. OAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.

Tokens de acesso granulares para "Update an issue type"

Este endpoint funciona com os seguintes tipos de token granulares:

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

  • "Issue Types" user permissions (write)

Parâmetros para "Update an issue type"

Cabeçalhos
accept string

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

Parâmetros de caminho
issue_type_id integer Obrigatório

The unique identifier of the issue type.

Parâmetros do corpo
name string Obrigatório

Name of the issue type.

is_enabled boolean Obrigatório

Whether or not the issue type is enabled.

description string or null

Description of the issue type.

color string or null

Color for the issue type.

Pode ser um dos: gray, blue, green, yellow, orange, red, pink, purple, null

Códigos de status de resposta HTTP para "Update an issue type"

Código de statusDescrição
200

OK

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

Exemplos de código para "Update an issue type"

Exemplo de solicitação

put/user/issue-types/{issue_type_id}
curl -L \ -X PUT \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2026-03-10" \ https://api.github.com/user/issue-types/ISSUE_TYPE_ID \ -d '{"name":"Epic","description":"An issue type for a multi-week tracking of work","is_enabled":true,"color":"green"}'

Response

Status: 200
{ "id": 410, "node_id": "IT_kwDNAd3NAZo", "name": "Task", "description": "A specific piece of work", "created_at": "2024-12-11T14:39:09Z", "updated_at": "2024-12-11T14:39:09Z" }

Delete an issue type

Deletes an issue type for the authenticated user.

The authenticated user must own the issue type. OAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.

Tokens de acesso granulares para "Delete an issue type"

Este endpoint funciona com os seguintes tipos de token granulares:

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

  • "Issue Types" user permissions (write)

Parâmetros para "Delete an issue type"

Cabeçalhos
accept string

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

Parâmetros de caminho
issue_type_id integer Obrigatório

The unique identifier of the issue type.

Códigos de status de resposta HTTP para "Delete an issue type"

Código de statusDescrição
204

No Content

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

Exemplos de código para "Delete an issue type"

Exemplo de solicitação

delete/user/issue-types/{issue_type_id}
curl -L \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2026-03-10" \ https://api.github.com/user/issue-types/ISSUE_TYPE_ID

Response

Status: 204