Skip to main content
Skip to content

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 acceso granulares para "List issue types"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener el siguiente conjunto de permisos:

  • "Issue Types" user permissions (read)

Códigos de estado de respuesta HTTP para "List issue types"

código de estadoDescripción
200

OK

404

Resource not found

Ejemplos de código para "List issue types"

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

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 acceso granulares para "Create an issue type"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener el siguiente conjunto de permisos:

  • "Issue Types" user permissions (write)

Parámetros para "Create an issue type"

Encabezados
Nombre, Tipo, Descripción
accept string

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

Parámetros del cuerpo
Nombre, Tipo, Descripción
name string Obligatorio

Name of the issue type.

is_enabled boolean Obligatorio

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.

Puede ser uno de los siguientes: gray, blue, green, yellow, orange, red, pink, purple, null

Códigos de estado de respuesta HTTP para "Create an issue type"

código de estadoDescripción
200

OK

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

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

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

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 acceso granulares para "Update an issue type"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener el siguiente conjunto de permisos:

  • "Issue Types" user permissions (write)

Parámetros para "Update an issue type"

Encabezados
Nombre, Tipo, Descripción
accept string

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

Parámetros de ruta
Nombre, Tipo, Descripción
issue_type_id integer Obligatorio

The unique identifier of the issue type.

Parámetros del cuerpo
Nombre, Tipo, Descripción
name string Obligatorio

Name of the issue type.

is_enabled boolean Obligatorio

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.

Puede ser uno de los siguientes: gray, blue, green, yellow, orange, red, pink, purple, null

Códigos de estado de respuesta HTTP para "Update an issue type"

código de estadoDescripción
200

OK

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

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

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

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 acceso granulares para "Delete an issue type"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener el siguiente conjunto de permisos:

  • "Issue Types" user permissions (write)

Parámetros para "Delete an issue type"

Encabezados
Nombre, Tipo, Descripción
accept string

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

Parámetros de ruta
Nombre, Tipo, Descripción
issue_type_id integer Obligatorio

The unique identifier of the issue type.

Códigos de estado de respuesta HTTP para "Delete an issue type"

código de estadoDescripción
204

No Content

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

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

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

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