Skip to main content
Ahora la API REST está versionada. Para obtener más información, consulta "Acerca del control de versiones de la API".

Puntos de conexión de la API REST para los valores de campo de problema

Use la API REST para ver y administrar los valores de los campos de incidencias.

List issue field values for an issue

Lists all issue field values for an issue.

fine_grained_access

works_with_fine_grained_tokens:

permission_set:

  • "Issues" repository permissions (read)

allows_public_read_access

Parámetros para "List issue field values for an issue"

Encabezados
Nombre, Tipo, Descripción
accept string

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

Parámetros de ruta
Nombre, Tipo, Descripción
owner string Obligatorio

The account owner of the repository. The name is not case sensitive.

repo string Obligatorio

The name of the repository without the .git extension. The name is not case sensitive.

issue_number integer Obligatorio

The number that identifies the issue.

Parámetros de consulta
Nombre, Tipo, Descripción
per_page integer

The number of results per page (max 100). For more information, see "Using pagination in the REST API."

Valor predeterminado: 30

page integer

The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Valor predeterminado: 1

http_status_code

status_codeDescripción
200

OK

301

Moved permanently

404

Resource not found

410

Gone

code_samples

request_example

get/repos/{owner}/{repo}/issues/{issue_number}/issue-field-values
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/repos/OWNER/REPO/issues/ISSUE_NUMBER/issue-field-values

Response

Status: 200
[ { "issue_field_id": 1, "node_id": "IFT_GDKND", "data_type": "text", "value": "DRI" }, { "issue_field_id": 2, "node_id": "IFSS_SADMS", "data_type": "single_select", "value": 1, "single_select_option": { "id": 1, "name": "High", "color": "red" } }, { "issue_field_id": 3, "node_id": "IFN_POINTS", "data_type": "number", "value": 42 }, { "issue_field_id": 4, "node_id": "IFD_DUEDATE", "data_type": "date", "value": "2025-12-25" } ]

Add issue field values to an issue

Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization. Adding an empty array will clear all existing field values for the issue.

This endpoint supports the following field data types:

  • text: String values for text fields
  • single_select: Option names for single-select fields (must match an existing option name)
  • number: Numeric values for number fields
  • date: ISO 8601 date strings for date fields

Only users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a 403 Forbidden response.

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "Rate limits for the API" and "Best practices for using the REST API."

fine_grained_access

works_with_fine_grained_tokens:

permission_sets:

  • "Issues" repository permissions (write)
  • "Pull requests" repository permissions (write)

Parámetros para "Add issue field values to an issue"

Encabezados
Nombre, Tipo, Descripción
accept string

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

Parámetros de ruta
Nombre, Tipo, Descripción
owner string Obligatorio

The account owner of the repository. The name is not case sensitive.

repo string Obligatorio

The name of the repository without the .git extension. The name is not case sensitive.

issue_number integer Obligatorio

The number that identifies the issue.

Parámetros del cuerpo
Nombre, Tipo, Descripción
issue_field_values array of objects

An array of issue field values to add to this issue. Each field value must include the field ID and the value to set.

Nombre, Tipo, Descripción
field_id integer Obligatorio

The ID of the issue field to set

value string or number Obligatorio

The value to set for the field. The type depends on the field's data type:

  • For text fields: provide a string value
  • For single_select fields: provide the option name as a string (must match an existing option)
  • For number fields: provide a numeric value
  • For date fields: provide an ISO 8601 date string

http_status_code

status_codeDescripción
200

OK

400

Bad Request

403

Forbidden

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

503

Service unavailable

code_samples

request_example

post/repos/{owner}/{repo}/issues/{issue_number}/issue-field-values
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/repos/OWNER/REPO/issues/ISSUE_NUMBER/issue-field-values \ -d '{"issue_field_values":[{"field_id":123,"value":"Critical"},{"field_id":456,"value":5},{"field_id":789,"value":"2024-12-31"}]}'

Response

Status: 200
[ { "issue_field_id": 1, "node_id": "IFT_GDKND", "data_type": "text", "value": "DRI" }, { "issue_field_id": 2, "node_id": "IFSS_SADMS", "data_type": "single_select", "value": 1, "single_select_option": { "id": 1, "name": "High", "color": "red" } }, { "issue_field_id": 3, "node_id": "IFN_POINTS", "data_type": "number", "value": 42 }, { "issue_field_id": 4, "node_id": "IFD_DUEDATE", "data_type": "date", "value": "2025-12-25" } ]

Set issue field values for an issue

Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization.

This endpoint supports the following field data types:

  • text: String values for text fields
  • single_select: Option names for single-select fields (must match an existing option name)
  • number: Numeric values for number fields
  • date: ISO 8601 date strings for date fields

This operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the POST endpoint instead.

Only users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a 403 Forbidden response.

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "Rate limits for the API" and "Best practices for using the REST API."

fine_grained_access

works_with_fine_grained_tokens:

permission_sets:

  • "Issues" repository permissions (write)
  • "Pull requests" repository permissions (write)

Parámetros para "Set issue field values for an issue"

Encabezados
Nombre, Tipo, Descripción
accept string

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

Parámetros de ruta
Nombre, Tipo, Descripción
owner string Obligatorio

The account owner of the repository. The name is not case sensitive.

repo string Obligatorio

The name of the repository without the .git extension. The name is not case sensitive.

issue_number integer Obligatorio

The number that identifies the issue.

Parámetros del cuerpo
Nombre, Tipo, Descripción
issue_field_values array of objects

An array of issue field values to set for this issue. Each field value must include the field ID and the value to set. All existing field values will be replaced.

Nombre, Tipo, Descripción
field_id integer Obligatorio

The ID of the issue field to set

value string or number Obligatorio

The value to set for the field. The type depends on the field's data type:

  • For text fields: provide a string value
  • For single_select fields: provide the option name as a string (must match an existing option)
  • For number fields: provide a numeric value
  • For date fields: provide an ISO 8601 date string

http_status_code

status_codeDescripción
200

OK

400

Bad Request

403

Forbidden

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

503

Service unavailable

code_samples

request_example

put/repos/{owner}/{repo}/issues/{issue_number}/issue-field-values
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/repos/OWNER/REPO/issues/ISSUE_NUMBER/issue-field-values \ -d '{"issue_field_values":[{"field_id":123,"value":"Critical"},{"field_id":456,"value":5},{"field_id":789,"value":"2024-12-31"}]}'

Response

Status: 200
[ { "issue_field_id": 1, "node_id": "IFT_GDKND", "data_type": "text", "value": "DRI" }, { "issue_field_id": 2, "node_id": "IFSS_SADMS", "data_type": "single_select", "value": 1, "single_select_option": { "id": 1, "name": "High", "color": "red" } }, { "issue_field_id": 3, "node_id": "IFN_POINTS", "data_type": "number", "value": 42 }, { "issue_field_id": 4, "node_id": "IFD_DUEDATE", "data_type": "date", "value": "2025-12-25" } ]

Delete an issue field value from an issue

Remove a specific custom field value from an issue.

Only users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a 403 Forbidden response.

If the specified field does not have a value set on the issue, this operation will return a 404 error.

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "Rate limits for the API" and "Best practices for using the REST API."

fine_grained_access

works_with_fine_grained_tokens:

permission_sets:

  • "Issues" repository permissions (write)
  • "Pull requests" repository permissions (write)

Parámetros para "Delete an issue field value from an issue"

Encabezados
Nombre, Tipo, Descripción
accept string

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

Parámetros de ruta
Nombre, Tipo, Descripción
owner string Obligatorio

The account owner of the repository. The name is not case sensitive.

repo string Obligatorio

The name of the repository without the .git extension. The name is not case sensitive.

issue_number integer Obligatorio

The number that identifies the issue.

issue_field_id integer Obligatorio

The unique identifier of the issue field.

http_status_code

status_codeDescripción
204

Issue field value deleted successfully

403

Forbidden

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

503

Service unavailable

code_samples

request_example

delete/repos/{owner}/{repo}/issues/{issue_number}/issue-field-values/{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/repos/OWNER/REPO/issues/ISSUE_NUMBER/issue-field-values/ISSUE_FIELD_ID

Issue field value deleted successfully

Status: 204