Skip to content

GitHub: List issue events for a repository

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

← Issues operations · Get started

Operation github.issues_list_events_for_repo

Provider route: GET /repos/{owner}/{repo}/issues/events. Alter supplies the connection’s credentials and routing.

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"]["issuesListEventsForRepo"]>[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.issuesListEventsForRepo(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_events_for_repo(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.ownerstringRequired within parent
path.repostringRequired within parent
queryobjectOptionalAdditional keys: not allowed
query.per_pageintegerOptionalDefault: 30
query.pageintegerOptionalDefault: 1

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

FieldTypePresenceDescription and constraints
$arrayRoot
$[]ModelEach itemExpand Get an issue event — response body

Referenced models: Get an issue event — response body

31 more schemas are linked from the tables above, on the schema pages.

Get an issue event — response body
FieldTypePresenceDescription and constraints
$objectRootIssue Event
actorModelRequired within parentExpand Get an issue — response body — user
assigneeModelOptionalExpand Get an issue — response body — user
assignerModelOptionalExpand Get an issue — response body — user
author_associationstringOptionalHow the author is associated with the repository.
Known values: COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNER
blocked_byModelOptionalExpand Get an issue event — response body — blocking
blockingModelOptionalExpand Get an issue event — response body — blocking
commit_idJSONRequired within parent
commit_id (anyOf 1)stringAlternative
commit_id (anyOf 2)nullAlternative
commit_urlJSONRequired within parent
commit_url (anyOf 1)stringAlternative
commit_url (anyOf 2)nullAlternative
created_atstringRequired within parentFormat: date-time
dismissed_reviewModelOptionalExpand Get an issue event — response body — dismissed review
eventstringRequired within parent
idJSONRequired within parent
id (anyOf 1)integerAlternativeFormat: int64
id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
intentModelOptionalExpand Get an issue event — response body — intent
issueModelOptionalExpand Get an issue event — response body — issue
issue_typeModelOptionalExpand Get an issue event — response body — issue type
labelModelOptionalExpand Get an issue event — response body — label
lock_reasonJSONOptional
lock_reason (anyOf 1)stringAlternative
lock_reason (anyOf 2)nullAlternative
milestoneModelOptionalExpand Get an issue event — response body — milestone
node_idstringRequired within parent
parent_issueModelOptionalExpand Get an issue event — response body — blocking
performed_via_github_appModelOptionalExpand Get an app — response body
prev_issue_typeModelOptionalExpand Get an issue event — response body — issue type
project_cardModelOptionalExpand Get an issue event — response body — project card
renameModelOptionalExpand Get an issue event — response body — rename
requested_reviewerModelOptionalExpand Get an issue — response body — user
requested_teamModelOptionalExpand List teams — response body — item
review_requesterModelOptionalExpand Get an issue — response body — user
sub_issueModelOptionalExpand Get an issue event — response body — blocking
urlstringRequired within parentFormat: uri

Referenced models: Get an app — response body, Get an issue event — response body — dismissed review, Get an issue event — response body — label, Get an issue event — response body — milestone, Get an issue event — response body — project card, Get an issue event — response body — rename, Get an issue event — response body — issue type, Get an issue event — response body — issue, Get an issue event — response body — intent, Get an issue event — response body — blocking, Get an issue — response body — user, List teams — response body — item

Get an app — response body
FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)objectAlternativeGitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
$ (anyOf 1).client_idstringOptional
$ (anyOf 1).created_atstringRequired within parentFormat: date-time
$ (anyOf 1).descriptionJSONRequired within parent
$ (anyOf 1).description (anyOf 1)stringAlternative
$ (anyOf 1).description (anyOf 2)nullAlternative
$ (anyOf 1).eventsarrayRequired within parentThe list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.
$ (anyOf 1).events[]stringEach item
$ (anyOf 1).external_urlstringRequired within parentFormat: uri
$ (anyOf 1).html_urlstringRequired within parentFormat: uri
$ (anyOf 1).idJSONRequired within parent
$ (anyOf 1).id (anyOf 1)integerAlternativeUnique identifier of the GitHub app
$ (anyOf 1).id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 1).installations_countJSONOptional
$ (anyOf 1).installations_count (anyOf 1)integerAlternativeThe number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.
$ (anyOf 1).installations_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 1).namestringRequired within parentThe name of the GitHub app
$ (anyOf 1).node_idstringRequired within parent
$ (anyOf 1).ownerJSONRequired within parent
$ (anyOf 1).owner (anyOf 1)ModelAlternativeExpand List users — response body — item
$ (anyOf 1).owner (anyOf 2)ModelAlternativeExpand Get an app — response body — client id, created at, description, events, external url, html url, id, installations count, name, node id, owner, permissions, slug, updated at owner Enterprise
$ (anyOf 1).permissionsobjectRequired within parentThe set of permissions for the GitHub app
Additional keys: see wildcard field
$ (anyOf 1).permissions.checksstringOptional
$ (anyOf 1).permissions.contentsstringOptional
$ (anyOf 1).permissions.deploymentsstringOptional
$ (anyOf 1).permissions.issuesstringOptional
$ (anyOf 1).permissions.metadatastringOptional
$ (anyOf 1).permissions.*stringAdditional keys
$ (anyOf 1).slugstringOptionalThe slug name of the GitHub app
$ (anyOf 1).updated_atstringRequired within parentFormat: date-time
$ (anyOf 2)nullAlternative

Referenced models: Get an app — response body — client id, created at, description, events, external url, html url, id, installations count, name, node id, owner, permissions, slug, updated at owner Enterprise, List users — response body — item

Get an issue event — response body — dismissed review
FieldTypePresenceDescription and constraints
$objectRoot
dismissal_commit_idJSONOptional
dismissal_commit_id (anyOf 1)stringAlternative
dismissal_commit_id (anyOf 2)nullAlternative
dismissal_messageJSONRequired within parent
dismissal_message (anyOf 1)stringAlternative
dismissal_message (anyOf 2)nullAlternative
review_idJSONRequired within parent
review_id (anyOf 1)integerAlternative
review_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
statestringRequired within parent

SDK function policy ID: github.issues_list_events_for_repo. Catalog operation: issues/list-events-for-repo. 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

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.