GitHub: List issue suggestions

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

Operation github.issues_list_suggestions

Provider route: GET /repos/{owner}/{repo}/issues/{issue_number}/suggestions. 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"]["issuesListSuggestions"]>[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.issuesListSuggestions(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_suggestions(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.state`	string	Optional	Default: pending One of: pending, applied, approved, dismissed, replaced, invalidated, all
`query.action`	string	Optional	One of: set_type, add_label, add_field, add_assignee, close_issue
`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 Approve an issue suggestion — response body

Referenced models: Approve an issue suggestion — response body

Schemas

Approve an issue suggestion — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	An agent-proposed change to an issue that a maintainer can approve or dismiss.
`action`	string	Required within parent	The kind of change proposed. Known values: set_type, add_label, add_field, add_assignee, close_issue
`actor_id`	JSON	Required within parent
`actor_id (anyOf 1)`	JSON	Alternative
`actor_id (anyOf 1) (anyOf 1)`	integer	Alternative	The unique identifier of the actor that proposed the suggestion.
`actor_id (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`actor_id (anyOf 2)`	null	Alternative
`confidence`	JSON	Required within parent
`confidence (anyOf 1)`	string	Alternative	The actor's confidence level in the suggestion. Known values: LOW, MEDIUM, HIGH
`confidence (anyOf 2)`	null	Alternative
`created_at`	string	Required within parent	The time the suggestion was created. Format: date-time
`id`	JSON	Required within parent
`id (anyOf 1)`	integer	Alternative	The unique identifier of the suggestion.
`id (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`issue_event_id`	JSON	Required within parent
`issue_event_id (anyOf 1)`	JSON	Alternative
`issue_event_id (anyOf 1) (anyOf 1)`	integer	Alternative	The identifier of the timeline event created when the suggestion was approved, when applicable.
`issue_event_id (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`issue_event_id (anyOf 2)`	null	Alternative
`issue_id`	JSON	Required within parent
`issue_id (anyOf 1)`	integer	Alternative	The unique identifier of the issue the suggestion applies to.
`issue_id (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`rationale`	JSON	Required within parent
`rationale (anyOf 1)`	string	Alternative	The rationale the actor provided for the suggestion.
`rationale (anyOf 2)`	null	Alternative
`resolved_by`	JSON	Required within parent
`resolved_by (anyOf 1)`	JSON	Alternative
`resolved_by (anyOf 1) (anyOf 1)`	integer	Alternative	The unique identifier of the user who approved or dismissed the suggestion.
`resolved_by (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`resolved_by (anyOf 2)`	null	Alternative
`state`	string	Required within parent	The suggestion's lifecycle state. Known values: pending, applied, approved, dismissed, replaced, invalidated
`target_id`	JSON	Required within parent
`target_id (anyOf 1)`	JSON	Alternative
`target_id (anyOf 1) (anyOf 1)`	integer	Alternative	The identifier of the target the change applies to (issue type, label, field, assignee, or duplicate issue), when applicable.
`target_id (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`target_id (anyOf 2)`	null	Alternative
`target_value`	JSON	Required within parent
`target_value (anyOf 1)`	JSON	Alternative	The proposed value, when applicable. An array for multi-select field suggestions.
`target_value (anyOf 1) (anyOf 1)`	string	Alternative
`target_value (anyOf 1) (anyOf 2)`	JSON	Alternative
`target_value (anyOf 1) (anyOf 2) (anyOf 1)`	number	Alternative
`target_value (anyOf 1) (anyOf 2) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`target_value (anyOf 1) (anyOf 3)`	boolean	Alternative
`target_value (anyOf 1) (anyOf 4)`	array	Alternative
`target_value (anyOf 1) (anyOf 4)[]`	string	Each item
`target_value (anyOf 2)`	null	Alternative
`updated_at`	string	Required within parent	The time the suggestion was last updated. Format: date-time

Policy, approvals and errors

SDK function policy ID: github.issues_list_suggestions. Catalog operation: issues/list-suggestions. 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