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.

Feinkörnige Zugriffstoken für "List issue types"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss über den folgenden Berechtigungssatz verfügen.:

  • "Issue Types" user permissions (read)

HTTP-Antwortstatuscodes für "List issue types"

StatuscodeBESCHREIBUNG
200

OK

404

Resource not found

Codebeispiele für "List issue types"

Anforderungsbeispiel

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.

Feinkörnige Zugriffstoken für "Create an issue type"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss über den folgenden Berechtigungssatz verfügen.:

  • "Issue Types" user permissions (write)

Parameter für "Create an issue type"

Header
Name, Typ, BESCHREIBUNG
accept string

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

Körperparameter
Name, Typ, BESCHREIBUNG
name string Erforderlich

Name of the issue type.

is_enabled boolean Erforderlich

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.

Kann eine der folgenden sein: gray, blue, green, yellow, orange, red, pink, purple, null

HTTP-Antwortstatuscodes für "Create an issue type"

StatuscodeBESCHREIBUNG
200

OK

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

Codebeispiele für "Create an issue type"

Anforderungsbeispiel

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.

Feinkörnige Zugriffstoken für "Update an issue type"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss über den folgenden Berechtigungssatz verfügen.:

  • "Issue Types" user permissions (write)

Parameter für "Update an issue type"

Header
Name, Typ, BESCHREIBUNG
accept string

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

Pfadparameter
Name, Typ, BESCHREIBUNG
issue_type_id integer Erforderlich

The unique identifier of the issue type.

Körperparameter
Name, Typ, BESCHREIBUNG
name string Erforderlich

Name of the issue type.

is_enabled boolean Erforderlich

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.

Kann eine der folgenden sein: gray, blue, green, yellow, orange, red, pink, purple, null

HTTP-Antwortstatuscodes für "Update an issue type"

StatuscodeBESCHREIBUNG
200

OK

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

Codebeispiele für "Update an issue type"

Anforderungsbeispiel

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.

Feinkörnige Zugriffstoken für "Delete an issue type"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss über den folgenden Berechtigungssatz verfügen.:

  • "Issue Types" user permissions (write)

Parameter für "Delete an issue type"

Header
Name, Typ, BESCHREIBUNG
accept string

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

Pfadparameter
Name, Typ, BESCHREIBUNG
issue_type_id integer Erforderlich

The unique identifier of the issue type.

HTTP-Antwortstatuscodes für "Delete an issue type"

StatuscodeBESCHREIBUNG
204

No Content

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

Codebeispiele für "Delete an issue type"

Anforderungsbeispiel

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