REST API endpoints for issue fields

Use the REST API to create and manage issue fields for the authenticated user.

List issue fields

Lists all issue fields for the authenticated user. OAuth app tokens and personal access tokens (classic) need the read:user scope to use this endpoint.

Детализированные токены доступа для «List issue fields»

Эта конечная точка работает со следующими точными типами маркеров:

Маркер с точной детализацией должен иметь следующий набор разрешений.:

  • "Issue Fields" user permissions (read)

HTTP-коды статуса ответа для «List issue fields»

Код состоянияDescription
200

OK

404

Resource not found

Примеры кода для «List issue fields»

Если вы получаете доступ к GitHub на GHE.com, замените api.github.com на выделенный поддомен вашего предприятия в api.SUBDOMAIN.ghe.com.

Пример запроса

get/user/issue-fields
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-fields

Response

Status: 200
[ { "id": 1, "node_id": "IFT_kwDNAd3NAZo", "name": "Text field", "description": "DRI", "data_type": "text", "created_at": "2024-12-11T14:39:09Z", "updated_at": "2024-12-11T14:39:09Z" }, { "id": 2, "node_id": "IFSS_kwDNAd3NAZs", "name": "Priority", "description": "Level of importance", "data_type": "single_select", "options": [ { "id": 1, "name": "High", "color": "red" }, { "id": 2, "name": "Medium", "color": "yellow" }, { "id": 3, "name": "Low", "color": "green" } ], "created_at": "2024-12-11T14:39:09Z", "updated_at": "2024-12-11T14:39:09Z" }, { "id": 3, "node_id": "IFMS_kwDNAd3NAZt", "name": "Categories", "description": "Issue categories", "data_type": "multi_select", "options": [ { "id": 4, "name": "Frontend", "color": "blue" }, { "id": 5, "name": "Backend", "color": "green" }, { "id": 6, "name": "Infrastructure", "color": "purple" } ], "created_at": "2024-12-11T14:39:09Z", "updated_at": "2024-12-11T14:39:09Z" } ]

Create an issue field

Creates a new issue field 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 field»

Эта конечная точка работает со следующими точными типами маркеров:

Маркер с точной детализацией должен иметь следующий набор разрешений.:

  • "Issue Fields" user permissions (write)

Параметры для «Create an issue field»

Заголовки
accept string

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

Параметры запроса
name string Обязательное поле

Name of the issue field.

description string or null

Description of the issue field.

data_type string Обязательное поле

The data type of the issue field.

Возможные значения: text, date, single_select, multi_select, number

visibility string

The visibility of the issue field. Can be restricted (visible only to the owner and to collaborators on the repository the field is read through) or all (visible to all users who can see issues). Defaults to restricted.

Возможные значения: restricted, all

options array of objects or null

Options for select fields. Required when data_type is 'single_select' or 'multi_select'.

name string Обязательное поле

Name of the option.

description string or null

Description of the option.

color string Обязательное поле

Color for the option.

Возможные значения: gray, blue, green, yellow, orange, red, pink, purple

priority integer Обязательное поле

Priority of the option for ordering.

HTTP-коды статуса ответа для «Create an issue field»

Код состоянияDescription
200

OK

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

Примеры кода для «Create an issue field»

Если вы получаете доступ к GitHub на GHE.com, замените api.github.com на выделенный поддомен вашего предприятия в api.SUBDOMAIN.ghe.com.

Пример запроса

post/user/issue-fields
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-fields \ -d '{"name":"Priority","description":"Level of importance for the issue","data_type":"single_select","visibility":"restricted","options":[{"name":"High","description":"High priority","color":"red","priority":1},{"name":"Medium","description":"Medium priority","color":"yellow","priority":2},{"name":"Low","description":"Low priority","color":"green","priority":3}]}'

Response

Status: 200
{ "id": 512, "node_id": "IF_kwDNAd3NAZr", "name": "Priority", "description": "Level of importance for the issue", "data_type": "single_select", "options": [ { "id": 1, "name": "High", "description": "High priority", "color": "red", "priority": 1, "created_at": "2025-01-15T10:30:15Z", "updated_at": "2025-01-15T10:30:15Z" }, { "id": 2, "name": "Medium", "description": "Medium priority", "color": "yellow", "priority": 2, "created_at": "2025-01-15T10:30:15Z", "updated_at": "2025-01-15T10:30:15Z" }, { "id": 3, "name": "Low", "description": "Low priority", "color": "green", "priority": 3, "created_at": "2025-01-15T10:30:15Z", "updated_at": "2025-01-15T10:30:15Z" } ], "created_at": "2025-01-15T10:30:15Z", "updated_at": "2025-01-15T10:30:15Z" }

Update an issue field

Updates an issue field for the authenticated user.

The authenticated user must own the issue field. OAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.

Детализированные токены доступа для «Update an issue field»

Эта конечная точка работает со следующими точными типами маркеров:

Маркер с точной детализацией должен иметь следующий набор разрешений.:

  • "Issue Fields" user permissions (write)

Параметры для «Update an issue field»

Заголовки
accept string

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

Параметры пути
issue_field_id integer Обязательное поле

The unique identifier of the issue field.

Параметры запроса
name string

Name of the issue field.

description string or null

Description of the issue field.

visibility string

The visibility of the issue field. Can be restricted (visible only to the owner and to collaborators on the repository the field is read through) or all (visible to all users who can see issues).

Возможные значения: restricted, all

options array of objects

Options for select fields. Only applicable when updating single_select or multi_select fields. When provided, this array replaces the entire existing set of options rather than adding to or updating individual options. To retain or update an existing option, include it in the array with its id. Options sent without an id are treated as new options and may cause existing options to be deleted and recreated.

id integer

The id of an existing option to retain or update. Omit this when creating a new option.

name string Обязательное поле

Name of the option.

description string or null

Description of the option.

color string Обязательное поле

Color for the option.

Возможные значения: gray, blue, green, yellow, orange, red, pink, purple

priority integer Обязательное поле

Priority of the option for ordering.

HTTP-коды статуса ответа для «Update an issue field»

Код состоянияDescription
200

OK

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

Примеры кода для «Update an issue field»

Если вы получаете доступ к GitHub на GHE.com, замените api.github.com на выделенный поддомен вашего предприятия в api.SUBDOMAIN.ghe.com.

Пример запроса

patch/user/issue-fields/{issue_field_id}
curl -L \ -X PATCH \ -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-fields/ISSUE_FIELD_ID \ -d '{"name":"Priority","description":"Level of importance for the issue"}'

Response

Status: 200
{ "id": 512, "node_id": "IF_kwDNAd3NAZr", "name": "Priority", "description": "Level of importance for the issue", "data_type": "single_select", "options": [ { "id": 1, "name": "High", "description": "High priority", "color": "red", "priority": 1, "created_at": "2025-01-15T10:30:15Z", "updated_at": "2025-01-15T10:30:15Z" }, { "id": 2, "name": "Medium", "description": "Medium priority", "color": "yellow", "priority": 2, "created_at": "2025-01-15T10:30:15Z", "updated_at": "2025-01-15T10:30:15Z" }, { "id": 3, "name": "Low", "description": "Low priority", "color": "green", "priority": 3, "created_at": "2025-01-15T10:30:15Z", "updated_at": "2025-01-15T10:30:15Z" } ], "created_at": "2025-01-15T10:30:15Z", "updated_at": "2025-01-15T10:30:15Z" }

Delete an issue field

Deletes an issue field for the authenticated user.

The authenticated user must own the issue field. OAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.

Детализированные токены доступа для «Delete an issue field»

Эта конечная точка работает со следующими точными типами маркеров:

Маркер с точной детализацией должен иметь следующий набор разрешений.:

  • "Issue Fields" user permissions (write)

Параметры для «Delete an issue field»

Заголовки
accept string

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

Параметры пути
issue_field_id integer Обязательное поле

The unique identifier of the issue field.

HTTP-коды статуса ответа для «Delete an issue field»

Код состоянияDescription
204

A header with no content is returned.

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

Примеры кода для «Delete an issue field»

Если вы получаете доступ к GitHub на GHE.com, замените api.github.com на выделенный поддомен вашего предприятия в api.SUBDOMAIN.ghe.com.

Пример запроса

delete/user/issue-fields/{issue_field_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-fields/ISSUE_FIELD_ID

A header with no content is returned.

Status: 204