REST API endpoints for issue types

List issue types for an organization

Lists all issue types for an organization.

Fine-grained access tokens for "List issue types for an organization"

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

"Issue Types" organization permissions (read)

Parameters for "List issue types for an organization"

Headers
Name, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Path parameters
Name, Type, Description
`org` string Required The organization name. The name is not case sensitive.

HTTP response status codes for "List issue types for an organization"

Status code	Description
`200`	OK
`404`	Resource not found

Code samples for "List issue types for an organization"

Request example

get/orgs/{org}/issue-types

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/orgs/ORG/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 issue type for an organization

Create a new issue type for an organization.

You can find out more about issue types in Managing issue types in an organization.

Fine-grained access tokens for "Create issue type for an organization"

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

"Issue Types" organization permissions (write)

Parameters for "Create issue type for an organization"

Headers
Name, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Path parameters
Name, Type, Description
`org` string Required The organization name. The name is not case sensitive.

Body parameters
Name, Type, Description
`name` string Required Name of the issue type.
`is_enabled` boolean Required Whether or not the issue type is enabled at the organization level.
`is_private` boolean Whether or not the issue type is restricted to issues in private repositories.
`description` string or null Description of the issue type.
`color` string or null Color for the issue type. Can be one of: `gray`, `blue`, `green`, `yellow`, `orange`, `red`, `pink`, `purple`, `null`

HTTP response status codes for "Create issue type for an organization"

Status code	Description
`200`	OK
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

Code samples for "Create issue type for an organization"

Request example

post/orgs/{org}/issue-types

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/orgs/ORG/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 issue type for an organization

Updates an issue type for an organization.

You can find out more about issue types in Managing issue types in an organization.

Fine-grained access tokens for "Update issue type for an organization"

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

"Issue Types" organization permissions (write)

Parameters for "Update issue type for an organization"

Headers
Name, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Path parameters
Name, Type, Description
`org` string Required The organization name. The name is not case sensitive.
`issue_type_id` integer Required The unique identifier of the issue type.

Body parameters
Name, Type, Description
`name` string Required Name of the issue type.
`is_enabled` boolean Required Whether or not the issue type is enabled at the organization level.
`is_private` boolean Whether or not the issue type is restricted to issues in private repositories.
`description` string or null Description of the issue type.
`color` string or null Color for the issue type. Can be one of: `gray`, `blue`, `green`, `yellow`, `orange`, `red`, `pink`, `purple`, `null`

HTTP response status codes for "Update issue type for an organization"

Status code	Description
`200`	OK
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

Code samples for "Update issue type for an organization"

Request example

put/orgs/{org}/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: 2022-11-28" \
  https://api.github.com/orgs/ORG/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 issue type for an organization

Deletes an issue type for an organization.

You can find out more about issue types in Managing issue types in an organization.

Fine-grained access tokens for "Delete issue type for an organization"

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

"Issue Types" organization permissions (write)

Parameters for "Delete issue type for an organization"

Headers
Name, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Path parameters
Name, Type, Description
`org` string Required The organization name. The name is not case sensitive.
`issue_type_id` integer Required The unique identifier of the issue type.

HTTP response status codes for "Delete issue type for an organization"

Status code	Description
`204`	No Content
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

Code samples for "Delete issue type for an organization"

Request example

delete/orgs/{org}/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: 2022-11-28" \
  https://api.github.com/orgs/ORG/issue-types/ISSUE_TYPE_ID

Response

Status: 204