Skip to main content
L’API REST est maintenant versionnée. Pour plus d’informations, consultez « À propos des versions de l’API ».

Points de terminaison d’API REST pour les valeurs de champ de problème

Utilisez l’API REST pour afficher et gérer les valeurs des champs de problème pour les problèmes.

List issue field values for an issue

Lists all issue field values for an issue.

Jetons d’accès affinés pour « List issue field values for an issue »

Ce point de terminaison fonctionne avec les types de jetons précis suivants:

Le jeton finement détaillé doit avoir l’ensemble d’autorisations suivant:

  • "Issues" repository permissions (read)

Ce point de terminaison peut être utilisé sans authentification ou sans les autorisations mentionnées ci-dessus si seules les ressources publiques sont demandées.

Paramètres pour « List issue field values for an issue »

En-têtes
Nom, Type, Description
accept string

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

Paramètres de chemin d’accès
Nom, Type, Description
owner string Requis

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

repo string Requis

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

issue_number integer Requis

The number that identifies the issue.

Paramètres de requête
Nom, Type, Description
per_page integer

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

Par défaut: 30

page integer

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

Par défaut: 1

Codes d’état de la réponse HTTP pour « List issue field values for an issue »

Code de statutDescription
200

OK

301

Moved permanently

404

Resource not found

410

Gone

Exemples de code pour « List issue field values for an issue »

Si vous accédez à GitHub à GHE.com, remplacez api.github.com par le sous-domaine dédié de votre entreprise à api.SUBDOMAIN.ghe.com.

Exemple de requête

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."

Jetons d’accès affinés pour « Add issue field values to an issue »

Ce point de terminaison fonctionne avec les types de jetons précis suivants:

Le jeton granulaire doit avoir au moins l’un des jeux d’autorisations suivants:

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

Paramètres pour « Add issue field values to an issue »

En-têtes
Nom, Type, Description
accept string

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

Paramètres de chemin d’accès
Nom, Type, Description
repository_id integer Requis

The unique identifier of the repository.

issue_number integer Requis

The number that identifies the issue.

Paramètres du corps
Nom, Type, Description
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.

Nom, Type, Description
field_id integer Requis

The ID of the issue field to set

value string or number Requis

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

Codes d’état de la réponse HTTP pour « Add issue field values to an issue »

Code de statutDescription
200

OK

400

Bad Request

403

Forbidden

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

503

Service unavailable

Exemples de code pour « Add issue field values to an issue »

Si vous accédez à GitHub à GHE.com, remplacez api.github.com par le sous-domaine dédié de votre entreprise à api.SUBDOMAIN.ghe.com.

Exemple de requête

post/repositories/{repository_id}/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/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 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."

Jetons d’accès affinés pour « Set issue field values for an issue »

Ce point de terminaison fonctionne avec les types de jetons précis suivants:

Le jeton granulaire doit avoir au moins l’un des jeux d’autorisations suivants:

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

Paramètres pour « Set issue field values for an issue »

En-têtes
Nom, Type, Description
accept string

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

Paramètres de chemin d’accès
Nom, Type, Description
repository_id integer Requis

The unique identifier of the repository.

issue_number integer Requis

The number that identifies the issue.

Paramètres du corps
Nom, Type, Description
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.

Nom, Type, Description
field_id integer Requis

The ID of the issue field to set

value string or number Requis

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

Codes d’état de la réponse HTTP pour « Set issue field values for an issue »

Code de statutDescription
200

OK

400

Bad Request

403

Forbidden

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

503

Service unavailable

Exemples de code pour « Set issue field values for an issue »

Si vous accédez à GitHub à GHE.com, remplacez api.github.com par le sous-domaine dédié de votre entreprise à api.SUBDOMAIN.ghe.com.

Exemple de requête

put/repositories/{repository_id}/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/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."

Jetons d’accès affinés pour « Delete an issue field value from an issue »

Ce point de terminaison fonctionne avec les types de jetons précis suivants:

Le jeton granulaire doit avoir au moins l’un des jeux d’autorisations suivants:

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

Paramètres pour « Delete an issue field value from an issue »

En-têtes
Nom, Type, Description
accept string

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

Paramètres de chemin d’accès
Nom, Type, Description
repository_id integer Requis

The unique identifier of the repository.

issue_number integer Requis

The number that identifies the issue.

issue_field_id integer Requis

The unique identifier of the issue field.

Codes d’état de la réponse HTTP pour « Delete an issue field value from an issue »

Code de statutDescription
204

Issue field value deleted successfully

403

Forbidden

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

503

Service unavailable

Exemples de code pour « Delete an issue field value from an issue »

Si vous accédez à GitHub à GHE.com, remplacez api.github.com par le sous-domaine dédié de votre entreprise à api.SUBDOMAIN.ghe.com.

Exemple de requête

delete/repositories/{repository_id}/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/repositories/REPOSITORY_ID/issues/ISSUE_NUMBER/issue-field-values/ISSUE_FIELD_ID

Issue field value deleted successfully

Status: 204