GitHub: List issue field values for an issue

GitHub issues.issuesListIssueFieldValuesForIssue: arguments, response, policy and SDK examples.

Operation github.issues_list_issue_field_values_for_issue

Provider route: GET /repos/{owner}/{repo}/issues/{issue_number}/issue-field-values. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/github with npm, or alter-sdk-github with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { GitHubIntegration } from "@alter-ai/github";

async function execute(input: Parameters<GitHubIntegration["issues"]["issuesListIssueFieldValuesForIssue"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new GitHubIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.issues.issuesListIssueFieldValuesForIssue(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_github import GitHubIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = GitHubIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.issues.issues_list_issue_field_values_for_issue(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`path`	object	Required within parent	Additional keys: not allowed
`path.owner`	string	Required within parent
`path.repo`	string	Required within parent
`path.issue_number`	integer	Required within parent
`query`	object	Optional	Additional keys: not allowed
`query.per_page`	integer	Optional	Default: 30
`query.page`	integer	Optional	Default: 1

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
`$`	array	Root
`$[]`	Model	Each item	Expand Add issue field values to an issue — response body — item

Referenced models: Add issue field values to an issue — response body — item

Schemas

Add issue field values to an issue — response body — item

Field	Type	Presence	Description and constraints
`$`	object	Root	A value assigned to an issue field
`data_type`	string	Required within parent	The data type of the issue field Known values: text, single_select, multi_select, number, date
`issue_field_id`	JSON	Required within parent
`issue_field_id (anyOf 1)`	integer	Alternative	Unique identifier for the issue field. Format: int64
`issue_field_id (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`issue_field_name`	string	Optional	The human-readable name of the issue field.
`multi_select_options`	JSON	Optional
`multi_select_options (anyOf 1)`	array	Alternative	Details about the selected options
`multi_select_options (anyOf 1)[]`	object	Each item
`multi_select_options (anyOf 1)[].color`	string	Required within parent	The color of the option
`multi_select_options (anyOf 1)[].id`	JSON	Required within parent
`multi_select_options (anyOf 1)[].id (anyOf 1)`	integer	Alternative	Unique identifier for the option. Format: int64
`multi_select_options (anyOf 1)[].id (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`multi_select_options (anyOf 1)[].name`	string	Required within parent	The name of the option
`multi_select_options (anyOf 2)`	null	Alternative
`node_id`	string	Required within parent
`single_select_option`	JSON	Optional
`single_select_option (anyOf 1)`	object	Alternative	Details about the selected option (only present for single_select fields)
`single_select_option (anyOf 1).color`	string	Required within parent	The color of the option
`single_select_option (anyOf 1).id`	JSON	Required within parent
`single_select_option (anyOf 1).id (anyOf 1)`	integer	Alternative	Unique identifier for the option. Format: int64
`single_select_option (anyOf 1).id (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`single_select_option (anyOf 1).name`	string	Required within parent	The name of the option
`single_select_option (anyOf 2)`	null	Alternative
`value`	JSON	Required within parent
`value (anyOf 1)`	JSON	Alternative	The value of the issue field
`value (anyOf 1) (anyOf 1)`	string	Alternative
`value (anyOf 1) (anyOf 2)`	JSON	Alternative
`value (anyOf 1) (anyOf 2) (anyOf 1)`	number	Alternative
`value (anyOf 1) (anyOf 2) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`value (anyOf 1) (anyOf 3)`	JSON	Alternative
`value (anyOf 1) (anyOf 3) (anyOf 1)`	integer	Alternative
`value (anyOf 1) (anyOf 3) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`value (anyOf 2)`	null	Alternative

Policy, approvals and errors

SDK function policy ID: github.issues_list_issue_field_values_for_issue. Catalog operation: issues/list-issue-field-values-for-issue. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"X-GitHub-Api-Version": "2026-03-10", "User-Agent": "Alter", "Accept": "application/vnd.github+json"}

Official provider source

Report an issue with this page