issues

List issue field values for an issue

Changed on

Lists all issue field values for an issue.

get/repos/{owner}/{repo}/issues/{issue_number}/issue-field-values

Request

  • Base URL: https://api.github.com
  • URL: https://api.github.com/repos/{owner}/{repo}/issues/{issue_number}/issue-field-values
  • Auth: none declared

Path parameters

ownerstring required

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

repostring required

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

issue_numberinteger required

The number that identifies the issue.

Query parameters

per_pageinteger

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

pageinteger

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

Response

Response

issue_field_idinteger required

Unique identifier for the issue field.

issue_field_namestring

The human-readable name of the issue field.

node_idstring required
data_type'text' | 'single_select' | 'multi_select' | 'number' | 'date' required

The data type of the issue field

Example response

[
  {
    "issue_field_id": 1,
    "issue_field_name": "Priority",
    "node_id": "IFT_GDKND",
    "data_type": "text",
    "value": "Sample text",
    "single_select_option": {
      "id": 1,
      "name": "High",
      "color": "red"
    },
    "multi_select_options": [
      {
        "id": 1,
        "name": "High",
        "color": "red"
      }
    ]
  }
]

Changes

  • 2022-11-2800a3fe4953d7Revision changes
    • info

      added the optional property / to the response with the status

  • 2022-11-2893714ad5c940Revision changes
    • warning

      added the new multi_select enum value to the / response property for the response status

    • info

      added the optional property / to the response with the status