REST API endpoints for issue types

Use the REST API to interact with issue types in an organization.

List issue types for an organization

GET /orgs/{org}/issue-types

Lists all issue types for an organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

Parameters

Headers

• accept (string)
  Setting to application/vnd.github+json is recommended.

Path and query parameters

• org (string) (required)
  The organization name. The name is not case sensitive.

HTTP response status codes

• 200 - OK

• 404 - Resource not found

Code examples

Example

Request:

curl -L \
  -X GET \
  https://api.github.com/orgs/ORG/issue-types

Response schema (Status: 200):

Array of Issue Type:

• id: required, integer
• node_id: required, string
• name: required, string
• description: required, string or null
• color: string or null, enum: gray, blue, green, yellow, orange, red, pink, purple, null
• created_at: string, format: date-time
• updated_at: string, format: date-time
• is_enabled: boolean

Create issue type for an organization

POST /orgs/{org}/issue-types

Create a new issue type for an organization.
You can find out more about issue types in Managing issue types in an organization.
To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and
personal access tokens (classic) need the admin:org scope to use this endpoint.

Parameters

Headers

• accept (string)
  Setting to application/vnd.github+json is recommended.

Path and query parameters

• org (string) (required)
  The organization name. The name is not case sensitive.

Body parameters

• name (string) (required)
  Name of the issue type.

• is_enabled (boolean) (required)
  Whether or not the issue type is enabled at the organization level.

• 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

• 200 - OK

• 404 - Resource not found

• 422 - Validation failed, or the endpoint has been spammed.

Code examples

Example

Request:

curl -L \
  -X POST \
  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 schema (Status: 200):

• id: required, integer
• node_id: required, string
• name: required, string
• description: required, string or null
• color: string or null, enum: gray, blue, green, yellow, orange, red, pink, purple, null
• created_at: string, format: date-time
• updated_at: string, format: date-time
• is_enabled: boolean

Update issue type for an organization

PUT /orgs/{org}/issue-types/{issue_type_id}

Updates an issue type for an organization.
You can find out more about issue types in Managing issue types in an organization.
To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and
personal access tokens (classic) need the admin:org scope to use this endpoint.

Parameters

Headers

• accept (string)
  Setting to application/vnd.github+json is recommended.

Path and query parameters

• 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 (string) (required)
  Name of the issue type.

• is_enabled (boolean) (required)
  Whether or not the issue type is enabled at the organization level.

• 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

• 200 - OK

• 404 - Resource not found

• 422 - Validation failed, or the endpoint has been spammed.

Code examples

Example

Request:

curl -L \
  -X PUT \
  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 schema (Status: 200):

Same response schema as Create issue type for an organization.

Delete issue type for an organization

DELETE /orgs/{org}/issue-types/{issue_type_id}

Deletes an issue type for an organization.
You can find out more about issue types in Managing issue types in an organization.
To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and
personal access tokens (classic) need the admin:org scope to use this endpoint.

Parameters

Headers

• accept (string)
  Setting to application/vnd.github+json is recommended.

Path and query parameters

• 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

• 204 - No Content

• 404 - Resource not found

• 422 - Validation failed, or the endpoint has been spammed.

Code examples

Example

Request:

curl -L \
  -X DELETE \
  https://api.github.com/orgs/ORG/issue-types/ISSUE_TYPE_ID

Response schema (Status: 204):