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.

Jetons d'accès granulaires pour «List issue types»

Ce point de terminaison fonctionne avec les types de tokens à granularité fine suivants:

Le token à granularité fine doit disposer de l’ensemble d’autorisations suivant:

  • "Issue Types" user permissions (read)

Codes d’état de réponse HTTP pour «List issue types »

Code de statutDescription
200

OK

404

Resource not found

Exemples de code pour «List issue types »

Si vous accédez à GitHub à GHE.com, remplacez api.github.com par le sous-domaine dédié de votre entreprise à api.SUBDOMAIN.ghe.com.

Exemple de requête

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.

Jetons d'accès granulaires pour «Create an issue type»

Ce point de terminaison fonctionne avec les types de tokens à granularité fine suivants:

Le token à granularité fine doit disposer de l’ensemble d’autorisations suivant:

  • "Issue Types" user permissions (write)

Paramètres pour «Create an issue type »

En-têtes
Nom, Type, Description
accept string

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

Paramètres du corps
Nom, Type, Description
name string Requis

Name of the issue type.

is_enabled boolean Requis

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.

Peut être l'un des: gray, blue, green, yellow, orange, red, pink, purple, null

Codes d’état de réponse HTTP pour «Create an issue type »

Code de statutDescription
200

OK

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

Exemples de code pour «Create an issue type »

Si vous accédez à GitHub à GHE.com, remplacez api.github.com par le sous-domaine dédié de votre entreprise à api.SUBDOMAIN.ghe.com.

Exemple de requête

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.

Jetons d'accès granulaires pour «Update an issue type»

Ce point de terminaison fonctionne avec les types de tokens à granularité fine suivants:

Le token à granularité fine doit disposer de l’ensemble d’autorisations suivant:

  • "Issue Types" user permissions (write)

Paramètres pour «Update an issue type »

En-têtes
Nom, Type, Description
accept string

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

Paramètres de chemin d’accès
Nom, Type, Description
issue_type_id integer Requis

The unique identifier of the issue type.

Paramètres du corps
Nom, Type, Description
name string Requis

Name of the issue type.

is_enabled boolean Requis

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.

Peut être l'un des: gray, blue, green, yellow, orange, red, pink, purple, null

Codes d’état de réponse HTTP pour «Update an issue type »

Code de statutDescription
200

OK

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

Exemples de code pour «Update an issue type »

Si vous accédez à GitHub à GHE.com, remplacez api.github.com par le sous-domaine dédié de votre entreprise à api.SUBDOMAIN.ghe.com.

Exemple de requête

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.

Jetons d'accès granulaires pour «Delete an issue type»

Ce point de terminaison fonctionne avec les types de tokens à granularité fine suivants:

Le token à granularité fine doit disposer de l’ensemble d’autorisations suivant:

  • "Issue Types" user permissions (write)

Paramètres pour «Delete an issue type »

En-têtes
Nom, Type, Description
accept string

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

Paramètres de chemin d’accès
Nom, Type, Description
issue_type_id integer Requis

The unique identifier of the issue type.

Codes d’état de réponse HTTP pour «Delete an issue type »

Code de statutDescription
204

No Content

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

Exemples de code pour «Delete an issue type »

Si vous accédez à GitHub à GHE.com, remplacez api.github.com par le sous-domaine dédié de votre entreprise à api.SUBDOMAIN.ghe.com.

Exemple de requête

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