REST API endpoints for issue field values
Use the REST API to view and manage issue field values for issues.
List issue field values for an issue
Lists all issue field values for an issue.
Tokens de acceso granulares para "List issue field values for an issue"
Este punto de conexión funciona con los siguientes tipos de token pormenorizados:
- Tokens de acceso de usuario de la aplicación de GitHub
- Token de acceso a la instalación de la aplicación de GitHub
- Tokens de acceso personal granulares
El token pormenorizado debe tener el siguiente conjunto de permisos:
- "Issues" repository permissions (read)
Este punto de conexión se puede usar sin autenticación o los permisos mencionados anteriormente si solo se solicitan recursos públicos.
Parámetros para "List issue field values for an issue"
| Nombre, Tipo, Descripción |
|---|
accept string Setting to |
| Nombre, Tipo, Descripción |
|---|
owner string ObligatorioThe account owner of the repository. The name is not case sensitive. |
repo string ObligatorioThe name of the repository without the |
issue_number integer ObligatorioThe number that identifies the issue. |
| 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: |
page integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Valor predeterminado: |
Códigos de estado de respuesta HTTP para "List issue field values for an issue"
| código de estado | Descripción |
|---|---|
200 | OK |
301 | Moved permanently |
404 | Resource not found |
410 | Gone |
Ejemplos de código para "List issue field values for an issue"
Ejemplo de solicitud
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-valuesResponse
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 fieldssingle_select: Option names for single-select fields (must match an existing option name)number: Numeric values for number fieldsdate: 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."
Tokens de acceso granulares para "Add issue field values to an issue"
Este punto de conexión funciona con los siguientes tipos de token pormenorizados:
- Tokens de acceso de usuario de la aplicación de GitHub
- Token de acceso a la instalación de la aplicación de GitHub
- Tokens de acceso personal granulares
El token pormenorizado debe tener al menos uno de los siguientes conjuntos de permisos:
- "Issues" repository permissions (write)
- "Pull requests" repository permissions (write)
Parámetros para "Add issue field values to an issue"
| Nombre, Tipo, Descripción |
|---|
accept string Setting to |
| Nombre, Tipo, Descripción |
|---|
repository_id integer ObligatorioThe unique identifier of the repository. |
issue_number integer ObligatorioThe number that identifies the issue. |
| 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. | |||
Properties of |
| Nombre, Tipo, Descripción |
|---|
field_id integer ObligatorioThe ID of the issue field to set |
value string or number ObligatorioThe value to set for the field. The type depends on the field's data type:
|
Códigos de estado de respuesta HTTP para "Add issue field values to an issue"
| código de estado | Descripción |
|---|---|
200 | OK |
400 | Bad Request |
403 | Forbidden |
404 | Resource not found |
422 | Validation failed, or the endpoint has been spammed. |
503 | Service unavailable |
Ejemplos de código para "Add issue field values to an issue"
Ejemplo de solicitud
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/repositories/REPOSITORY_ID/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 fieldssingle_select: Option names for single-select fields (must match an existing option name)number: Numeric values for number fieldsdate: 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."
Tokens de acceso granulares para "Set issue field values for an issue"
Este punto de conexión funciona con los siguientes tipos de token pormenorizados:
- Tokens de acceso de usuario de la aplicación de GitHub
- Token de acceso a la instalación de la aplicación de GitHub
- Tokens de acceso personal granulares
El token pormenorizado debe tener al menos uno de los siguientes conjuntos de permisos:
- "Issues" repository permissions (write)
- "Pull requests" repository permissions (write)
Parámetros para "Set issue field values for an issue"
| Nombre, Tipo, Descripción |
|---|
accept string Setting to |
| Nombre, Tipo, Descripción |
|---|
repository_id integer ObligatorioThe unique identifier of the repository. |
issue_number integer ObligatorioThe number that identifies the issue. |
| 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. | |||
Properties of |
| Nombre, Tipo, Descripción |
|---|
field_id integer ObligatorioThe ID of the issue field to set |
value string or number ObligatorioThe value to set for the field. The type depends on the field's data type:
|
Códigos de estado de respuesta HTTP para "Set issue field values for an issue"
| código de estado | Descripción |
|---|---|
200 | OK |
400 | Bad Request |
403 | Forbidden |
404 | Resource not found |
422 | Validation failed, or the endpoint has been spammed. |
503 | Service unavailable |
Ejemplos de código para "Set issue field values for an issue"
Ejemplo de solicitud
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/repositories/REPOSITORY_ID/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."
Tokens de acceso granulares para "Delete an issue field value from an issue"
Este punto de conexión funciona con los siguientes tipos de token pormenorizados:
- Tokens de acceso de usuario de la aplicación de GitHub
- Token de acceso a la instalación de la aplicación de GitHub
- Tokens de acceso personal granulares
El token pormenorizado debe tener al menos uno de los siguientes conjuntos de permisos:
- "Issues" repository permissions (write)
- "Pull requests" repository permissions (write)
Parámetros para "Delete an issue field value from an issue"
| Nombre, Tipo, Descripción |
|---|
accept string Setting to |
| Nombre, Tipo, Descripción |
|---|
repository_id integer ObligatorioThe unique identifier of the repository. |
issue_number integer ObligatorioThe number that identifies the issue. |
issue_field_id integer ObligatorioThe unique identifier of the issue field. |
Códigos de estado de respuesta HTTP para "Delete an issue field value from an issue"
| código de estado | Descripció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 |
Ejemplos de código para "Delete an issue field value from an issue"
Ejemplo de solicitud
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/repositories/REPOSITORY_ID/issues/ISSUE_NUMBER/issue-field-values/ISSUE_FIELD_IDIssue field value deleted successfully
Status: 204