GitHub: List repository invitations

GitHub repos.reposListInvitations: arguments, response, policy and SDK examples.

Operation github.repos_list_invitations

Provider route: GET /repos/{owner}/{repo}/invitations. 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["repos"]["reposListInvitations"]>[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.repos.reposListInvitations(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.repos.repos_list_invitations(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
`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 Update a repository invitation — response body

Referenced models: Update a repository invitation — response body

Schemas

1 more schema is linked from the tables above, on the schema pages.

Update a repository invitation — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Repository invitations let you manage who you collaborate with.
`created_at`	string	Required within parent	Format: date-time
`expired`	boolean	Optional	Whether or not the invitation has expired
`html_url`	string	Required within parent
`id`	JSON	Required within parent
`id (anyOf 1)`	integer	Alternative	Unique identifier of the repository invitation. Format: int64
`id (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`invitee`	Model	Required within parent	Expand Get an issue — response body — user
`inviter`	Model	Required within parent	Expand Get an issue — response body — user
`node_id`	string	Required within parent
`permissions`	string	Required within parent	The permission associated with the invitation. Known values: read, write, admin, triage, triage_plus, maintain
`repository`	Model	Required within parent	Expand Transfer a repository — response body
`url`	string	Required within parent	URL for the repository invitation

Referenced models: Transfer a repository — response body, Get an issue — response body — user

Get an issue — response body — user

Field	Type	Presence	Description and constraints
`$`	JSON	Root
`$ (anyOf 1)`	Model	Alternative	Expand Get an issue — response body — user A Git Hub user
`$ (anyOf 2)`	null	Alternative

Referenced models: Get an issue — response body — user A Git Hub user

Get a code of conduct — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Code Of Conduct
`body`	string	Optional
`html_url`	JSON	Required within parent
`html_url (anyOf 1)`	string	Alternative	Format: uri
`html_url (anyOf 2)`	null	Alternative
`key`	string	Required within parent
`name`	string	Required within parent
`url`	string	Required within parent	Format: uri

Create a fork — response body — security and analysis

Field	Type	Presence	Description and constraints
`$`	JSON	Root
`$ (anyOf 1)`	object	Alternative
`$ (anyOf 1).advanced_security`	object	Optional	Enable or disable GitHub Advanced Security for the repository. For standalone Code Scanning or Secret Protection products, this parameter cannot be used.
`$ (anyOf 1).advanced_security.status`	string	Optional	Known values: enabled, disabled
`$ (anyOf 1).code_security`	object	Optional
`$ (anyOf 1).code_security.status`	string	Optional	Known values: enabled, disabled
`$ (anyOf 1).dependabot_security_updates`	object	Optional	Enable or disable Dependabot security updates for the repository.
`$ (anyOf 1).dependabot_security_updates.status`	string	Optional	The enablement status of Dependabot security updates for the repository. Known values: enabled, disabled
`$ (anyOf 1).secret_scanning`	object	Optional
`$ (anyOf 1).secret_scanning.status`	string	Optional	Known values: enabled, disabled
`$ (anyOf 1).secret_scanning_ai_detection`	object	Optional
`$ (anyOf 1).secret_scanning_ai_detection.status`	string	Optional	Known values: enabled, disabled
`$ (anyOf 1).secret_scanning_delegated_alert_dismissal`	object	Optional
`$ (anyOf 1).secret_scanning_delegated_alert_dismissal.status`	string	Optional	Known values: enabled, disabled
`$ (anyOf 1).secret_scanning_delegated_bypass`	object	Optional
`$ (anyOf 1).secret_scanning_delegated_bypass.status`	string	Optional	Known values: enabled, disabled
`$ (anyOf 1).secret_scanning_delegated_bypass_options`	object	Optional
`$ (anyOf 1).secret_scanning_delegated_bypass_options.reviewers`	array	Optional	The bypass reviewers for secret scanning delegated bypass
`$ (anyOf 1).secret_scanning_delegated_bypass_options.reviewers[]`	object	Each item
`$ (anyOf 1).secret_scanning_delegated_bypass_options.reviewers[].mode`	string	Optional	The bypass mode for the reviewer Known values: ALWAYS, EXEMPT Default: ALWAYS
`$ (anyOf 1).secret_scanning_delegated_bypass_options.reviewers[].reviewer_id`	JSON	Required within parent
`$ (anyOf 1).secret_scanning_delegated_bypass_options.reviewers[].reviewer_id (anyOf 1)`	integer	Alternative	The ID of the team or role selected as a bypass reviewer
`$ (anyOf 1).secret_scanning_delegated_bypass_options.reviewers[].reviewer_id (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 1).secret_scanning_delegated_bypass_options.reviewers[].reviewer_type`	string	Required within parent	The type of the bypass reviewer Known values: TEAM, ROLE
`$ (anyOf 1).secret_scanning_non_provider_patterns`	object	Optional
`$ (anyOf 1).secret_scanning_non_provider_patterns.status`	string	Optional	Known values: enabled, disabled
`$ (anyOf 1).secret_scanning_push_protection`	object	Optional
`$ (anyOf 1).secret_scanning_push_protection.status`	string	Optional	Known values: enabled, disabled
`$ (anyOf 2)`	null	Alternative

List users — response body — item

Field	Type	Presence	Description and constraints
`$`	object	Root	A GitHub user.
`avatar_url`	string	Required within parent	Format: uri
`email`	JSON	Optional
`email (anyOf 1)`	string	Alternative
`email (anyOf 2)`	null	Alternative
`events_url`	string	Required within parent
`followers_url`	string	Required within parent	Format: uri
`following_url`	string	Required within parent
`gists_url`	string	Required within parent
`gravatar_id`	JSON	Required within parent
`gravatar_id (anyOf 1)`	string	Alternative
`gravatar_id (anyOf 2)`	null	Alternative
`html_url`	string	Required within parent	Format: uri
`id`	JSON	Required within parent
`id (anyOf 1)`	integer	Alternative	Format: int64
`id (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`login`	string	Required within parent
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative
`name (anyOf 2)`	null	Alternative
`node_id`	string	Required within parent
`organizations_url`	string	Required within parent	Format: uri
`received_events_url`	string	Required within parent	Format: uri
`repos_url`	string	Required within parent	Format: uri
`site_admin`	boolean	Required within parent
`starred_at`	string	Optional
`starred_url`	string	Required within parent
`subscriptions_url`	string	Required within parent	Format: uri
`type`	string	Required within parent
`url`	string	Required within parent	Format: uri
`user_view_type`	string	Optional

Get an issue — response body — user A Git Hub user

Field	Type	Presence	Description and constraints
`$`	object	Root	A GitHub user.
`avatar_url`	string	Required within parent	Format: uri
`email`	JSON	Optional
`email (anyOf 1)`	string	Alternative
`email (anyOf 2)`	null	Alternative
`events_url`	string	Required within parent
`followers_url`	string	Required within parent	Format: uri
`following_url`	string	Required within parent
`gists_url`	string	Required within parent
`gravatar_id`	JSON	Required within parent
`gravatar_id (anyOf 1)`	string	Alternative
`gravatar_id (anyOf 2)`	null	Alternative
`html_url`	string	Required within parent	Format: uri
`id`	JSON	Required within parent
`id (anyOf 1)`	integer	Alternative	Format: int64
`id (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`login`	string	Required within parent
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative
`name (anyOf 2)`	null	Alternative
`node_id`	string	Required within parent
`organizations_url`	string	Required within parent	Format: uri
`received_events_url`	string	Required within parent	Format: uri
`repos_url`	string	Required within parent	Format: uri
`site_admin`	boolean	Required within parent
`starred_at`	string	Optional
`starred_url`	string	Required within parent
`subscriptions_url`	string	Required within parent	Format: uri
`type`	string	Required within parent
`url`	string	Required within parent	Format: uri
`user_view_type`	string	Optional

Policy, approvals and errors

SDK function policy ID: github.repos_list_invitations. Catalog operation: repos/list-invitations. 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