REST API endpoints for issue types

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.

“List issue types”的细粒度访问令牌

此端点支持以下精细令牌类型:

细粒度令牌必须具有以下权限集:

"Issue Types" user permissions (read)

“List issue types”的 HTTP 响应状态代码

状态代码	说明
`200`	OK
`404`	Resource not found

“List issue types”的代码示例

如果你在 GHE.com 上访问 GitHub，请将 api.github.com 替换为企业的专用子域，位于 api.SUBDOMAIN.ghe.com。

请求示例

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.

“Create an issue type”的细粒度访问令牌

此端点支持以下精细令牌类型:

细粒度令牌必须具有以下权限集:

"Issue Types" user permissions (write)

“”Create an issue type 的参数

标头
名称, 类型, 说明
`accept` string Setting to `application/vnd.github+json` is recommended.

主体参数
名称, 类型, 说明
`name` string 必须 Name of the issue type.
`is_enabled` boolean 必须 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. 可以是以下选项之一: `gray`, `blue`, `green`, `yellow`, `orange`, `red`, `pink`, `purple`, `null`

“Create an issue type”的 HTTP 响应状态代码

状态代码	说明
`200`	OK
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

“Create an issue type”的代码示例

如果你在 GHE.com 上访问 GitHub，请将 api.github.com 替换为企业的专用子域，位于 api.SUBDOMAIN.ghe.com。

请求示例

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.

“Update an issue type”的细粒度访问令牌

此端点支持以下精细令牌类型:

细粒度令牌必须具有以下权限集:

"Issue Types" user permissions (write)

“”Update an issue type 的参数

标头
名称, 类型, 说明
`accept` string Setting to `application/vnd.github+json` is recommended.

路径参数
名称, 类型, 说明
`issue_type_id` integer 必须 The unique identifier of the issue type.

主体参数
名称, 类型, 说明
`name` string 必须 Name of the issue type.
`is_enabled` boolean 必须 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. 可以是以下选项之一: `gray`, `blue`, `green`, `yellow`, `orange`, `red`, `pink`, `purple`, `null`

“Update an issue type”的 HTTP 响应状态代码

状态代码	说明
`200`	OK
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

“Update an issue type”的代码示例

如果你在 GHE.com 上访问 GitHub，请将 api.github.com 替换为企业的专用子域，位于 api.SUBDOMAIN.ghe.com。

请求示例

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.

“Delete an issue type”的细粒度访问令牌

此端点支持以下精细令牌类型:

细粒度令牌必须具有以下权限集:

"Issue Types" user permissions (write)

“”Delete an issue type 的参数

标头
名称, 类型, 说明
`accept` string Setting to `application/vnd.github+json` is recommended.

路径参数
名称, 类型, 说明
`issue_type_id` integer 必须 The unique identifier of the issue type.

“Delete an issue type”的 HTTP 响应状态代码

状态代码	说明
`204`	No Content
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

“Delete an issue type”的代码示例

如果你在 GHE.com 上访问 GitHub，请将 api.github.com 替换为企业的专用子域，位于 api.SUBDOMAIN.ghe.com。

请求示例

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

List issue types

“List issue types”的细粒度访问令牌

“List issue types”的 HTTP 响应状态代码

“List issue types”的代码示例

请求示例

Response

Create an issue type

“Create an issue type”的细粒度访问令牌

“”Create an issue type 的参数

“Create an issue type”的 HTTP 响应状态代码

“Create an issue type”的代码示例

请求示例

Response

Update an issue type

“Update an issue type”的细粒度访问令牌

“”Update an issue type 的参数

“Update an issue type”的 HTTP 响应状态代码

“Update an issue type”的代码示例

请求示例

Response

Delete an issue type

“Delete an issue type”的细粒度访问令牌

“”Delete an issue type 的参数

“Delete an issue type”的 HTTP 响应状态代码

“Delete an issue type”的代码示例

请求示例

Response

此文档是否有帮助？

仍需帮助？