GitHub: List app installations accessible to the user access token
GitHub apps.appsListInstallationsForAuthenticatedUser: arguments, response, policy and SDK examples.
← Apps operations · Get started
Operation github.apps_list_installations_for_authenticated_user
Provider route: GET /user/installations. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “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["apps"]["appsListInstallationsForAuthenticatedUser"]>[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.apps.appsListInstallationsForAuthenticatedUser(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom 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.apps.apps_list_installations_for_authenticated_user(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.per_page | integer | Optional | Default: 30 |
query.page | integer | Optional | Default: 1 |
Response
Section titled “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 |
|---|---|---|---|
$ | object | Root | |
installations | array | Required within parent | |
installations[] | Model | Each item | Expand List app installations for an organization — response body — installations item |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | integer | Alternative | |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: List app installations for an organization — response body — installations item
Schemas
Section titled “Schemas”2 more schemas are linked from the tables above, on the schema pages.
List app installations for an organization — response body — installations item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Installation |
access_tokens_url | string | Required within parent | Format: uri |
account | JSON | Required within parent | |
account (anyOf 1) | JSON | Alternative | |
account (anyOf 1) (anyOf 1) | Model | Alternative | Expand List users — response body — item |
account (anyOf 1) (anyOf 2) | Model | Alternative | Expand 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 |
account (anyOf 2) | null | Alternative | |
app_id | JSON | Required within parent | |
app_id (anyOf 1) | integer | Alternative | |
app_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
app_slug | string | Required within parent | |
client_id | string | Optional | |
contact_email | JSON | Optional | |
contact_email (anyOf 1) | string | Alternative | |
contact_email (anyOf 2) | null | Alternative | |
created_at | string | Required within parent | Format: date-time |
events | array | Required within parent | |
events[] | string | Each item | |
has_multiple_single_files | boolean | Optional | |
html_url | string | Required within parent | Format: uri |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | The ID of the installation. |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
permissions | Model | Required within parent | Expand List app installations for an organization — response body — installations item permissions |
repositories_url | string | Required within parent | Format: uri |
repository_selection | string | Required within parent | Describe whether all repositories have been selected or there's a selection involved Known values: all, selected |
single_file_name | JSON | Required within parent | |
single_file_name (anyOf 1) | string | Alternative | |
single_file_name (anyOf 2) | null | Alternative | |
single_file_paths | array | Optional | |
single_file_paths[] | string | Each item | |
suspended_at | JSON | Required within parent | |
suspended_at (anyOf 1) | string | Alternative | Format: date-time |
suspended_at (anyOf 2) | null | Alternative | |
suspended_by | Model | Required within parent | Expand Get an issue — response body — user |
target_id | JSON | Required within parent | |
target_id (anyOf 1) | integer | Alternative | The ID of the user or organization this token is being scoped to. |
target_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
target_type | string | Required within parent | |
updated_at | string | Required within parent | Format: date-time |
Referenced models: List app installations for an organization — response body — installations item permissions, 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, Get an issue — response body — user, List users — response body — item
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An enterprise on GitHub. |
avatar_url | string | Required within parent | Format: uri |
created_at | JSON | Required within parent | |
created_at (anyOf 1) | string | Alternative | Format: date-time |
created_at (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | A short description of the enterprise. |
description (anyOf 2) | null | Alternative | |
html_url | string | Required within parent | Format: uri |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | Unique identifier of the enterprise |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
name | string | Required within parent | The name of the enterprise. |
node_id | string | Required within parent | |
slug | string | Required within parent | The slug url identifier for the enterprise. |
updated_at | JSON | Required within parent | |
updated_at (anyOf 1) | string | Alternative | Format: date-time |
updated_at (anyOf 2) | null | Alternative | |
website_url | JSON | Optional | |
website_url (anyOf 1) | string | Alternative | The enterprise's website URL. Format: uri |
website_url (anyOf 2) | null | Alternative |
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
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 |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: github.apps_list_installations_for_authenticated_user. Catalog operation: apps/list-installations-for-authenticated-user. 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"}