Skip to content

List app installations for an organization

GET
/orgs/{org}/installations

Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization.

The authenticated user must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the admin:read scope to use this endpoint.

API method documentation

org
required
string

The organization name. The name is not case sensitive.

per_page
integer
default: 30

The number of results per page (max 100). For more information, see “Using pagination in the REST API.”

page
integer
default: 1

The page number of the results to fetch. For more information, see “Using pagination in the REST API.”

Response

Media type application/json
object
total_count
required
integer
installations
required
Array<object>
Installation

Installation

object
id
required

The ID of the installation.

integer
account
required
Any of:
Simple User

A GitHub user.

object
name
string
nullable
email
string
nullable
login
required
string
id
required
integer format: int64
node_id
required
string
avatar_url
required
string format: uri
gravatar_id
required
string
nullable
url
required
string format: uri
html_url
required
string format: uri
followers_url
required
string format: uri
following_url
required
string
gists_url
required
string
starred_url
required
string
subscriptions_url
required
string format: uri
organizations_url
required
string format: uri
repos_url
required
string format: uri
events_url
required
string
received_events_url
required
string format: uri
type
required
string
site_admin
required
boolean
starred_at
string
user_view_type
string
repository_selection
required

Describe whether all repositories have been selected or there’s a selection involved

string
Allowed values: all selected
access_tokens_url
required
string format: uri
repositories_url
required
string format: uri
html_url
required
string format: uri
app_id
required
integer
client_id
string
target_id
required

The ID of the user or organization this token is being scoped to.

integer
target_type
required
string
permissions
required
App Permissions

The permissions granted to the fine-grained access token.

object
actions

The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.

string
Allowed values: read write
administration

The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.

string
Allowed values: read write
artifact_metadata

The level of permission to grant the access token to create and retrieve build artifact metadata records.

string
Allowed values: read write
attestations

The level of permission to create and retrieve the access token for repository attestations.

string
Allowed values: read write
checks

The level of permission to grant the access token for checks on code.

string
Allowed values: read write
code_quality

The level of permission to grant the access token to view and manage code quality data.

string
Allowed values: read write
codespaces

The level of permission to grant the access token to create, edit, delete, and list Codespaces.

string
Allowed values: read write
contents

The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.

string
Allowed values: read write
dependabot_secrets

The level of permission to grant the access token to manage Dependabot secrets.

string
Allowed values: read write
deployments

The level of permission to grant the access token for deployments and deployment statuses.

string
Allowed values: read write
discussions

The level of permission to grant the access token for discussions and related comments and labels.

string
Allowed values: read write
environments

The level of permission to grant the access token for managing repository environments.

string
Allowed values: read write
issues

The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.

string
Allowed values: read write
merge_queues

The level of permission to grant the access token to manage the merge queues for a repository.

string
Allowed values: read write
metadata

The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.

string
Allowed values: read write
packages

The level of permission to grant the access token for packages published to GitHub Packages.

string
Allowed values: read write
pages

The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.

string
Allowed values: read write
pull_requests

The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.

string
Allowed values: read write
repository_custom_properties

The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.

string
Allowed values: read write
repository_hooks

The level of permission to grant the access token to manage the post-receive hooks for a repository.

string
Allowed values: read write
repository_projects

The level of permission to grant the access token to manage repository projects, columns, and cards.

string
Allowed values: read write admin
secret_scanning_alerts

The level of permission to grant the access token to view and manage secret scanning alerts.

string
Allowed values: read write
secrets

The level of permission to grant the access token to manage repository secrets.

string
Allowed values: read write
security_events

The level of permission to grant the access token to view and manage security events like code scanning alerts.

string
Allowed values: read write
single_file

The level of permission to grant the access token to manage just a single file.

string
Allowed values: read write
statuses

The level of permission to grant the access token for commit statuses.

string
Allowed values: read write
vulnerability_alerts

The level of permission to grant the access token to manage Dependabot alerts.

string
Allowed values: read write
workflows

The level of permission to grant the access token to update GitHub Actions workflow files.

string
Allowed values: write
custom_properties_for_organizations

The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.

string
Allowed values: read write
members

The level of permission to grant the access token for organization teams and members.

string
Allowed values: read write
organization_administration

The level of permission to grant the access token to manage access to an organization.

string
Allowed values: read write
organization_custom_roles

The level of permission to grant the access token for custom repository roles management.

string
Allowed values: read write
organization_custom_org_roles

The level of permission to grant the access token for custom organization roles management.

string
Allowed values: read write
organization_custom_properties

The level of permission to grant the access token for repository custom properties management at the organization level.

string
Allowed values: read write admin
organization_copilot_seat_management

The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.

string
Allowed values: read write
organization_copilot_agent_settings

The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.

string
Allowed values: read write
organization_announcement_banners

The level of permission to grant the access token to view and manage announcement banners for an organization.

string
Allowed values: read write
organization_events

The level of permission to grant the access token to view events triggered by an activity in an organization.

string
Allowed values: read
organization_hooks

The level of permission to grant the access token to manage the post-receive hooks for an organization.

string
Allowed values: read write
organization_personal_access_tokens

The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.

string
Allowed values: read write
organization_personal_access_token_requests

The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.

string
Allowed values: read write
organization_plan

The level of permission to grant the access token for viewing an organization’s plan.

string
Allowed values: read
organization_projects

The level of permission to grant the access token to manage organization projects and projects public preview (where available).

string
Allowed values: read write admin
organization_packages

The level of permission to grant the access token for organization packages published to GitHub Packages.

string
Allowed values: read write
organization_secrets

The level of permission to grant the access token to manage organization secrets.

string
Allowed values: read write
organization_self_hosted_runners

The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.

string
Allowed values: read write
organization_user_blocking

The level of permission to grant the access token to view and manage users blocked by the organization.

string
Allowed values: read write
email_addresses

The level of permission to grant the access token to manage the email addresses belonging to a user.

string
Allowed values: read write
followers

The level of permission to grant the access token to manage the followers belonging to a user.

string
Allowed values: read write
git_ssh_keys

The level of permission to grant the access token to manage git SSH keys.

string
Allowed values: read write
gpg_keys

The level of permission to grant the access token to view and manage GPG keys belonging to a user.

string
Allowed values: read write
interaction_limits

The level of permission to grant the access token to view and manage interaction limits on a repository.

string
Allowed values: read write
profile

The level of permission to grant the access token to manage the profile settings belonging to a user.

string
Allowed values: write
starring

The level of permission to grant the access token to list and manage repositories a user is starring.

string
Allowed values: read write
enterprise_custom_properties_for_organizations

The level of permission to grant the access token for organization custom properties management at the enterprise level.

string
Allowed values: read write admin
events
required
Array<string>
created_at
required
string format: date-time
updated_at
required
string format: date-time
single_file_name
required
string
nullable
has_multiple_single_files
boolean
single_file_paths
Array<string>
app_slug
required
string
suspended_by
required
Simple User

A GitHub user.

object
name
string
nullable
email
string
nullable
login
required
string
id
required
integer format: int64
node_id
required
string
avatar_url
required
string format: uri
gravatar_id
required
string
nullable
url
required
string format: uri
html_url
required
string format: uri
followers_url
required
string format: uri
following_url
required
string
gists_url
required
string
starred_url
required
string
subscriptions_url
required
string format: uri
organizations_url
required
string format: uri
repos_url
required
string format: uri
events_url
required
string
received_events_url
required
string format: uri
type
required
string
site_admin
required
boolean
starred_at
string
user_view_type
string
suspended_at
required
string format: date-time
nullable
contact_email
string
nullable
Examples
Example default
{
"total_count": 1,
"installations": [
{
"id": 25381,
"account": {
"login": "octo-org",
"id": 6811672,
"node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=",
"avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4",
"gravatar_id": "",
"url": "https://api.github.com/users/octo-org",
"html_url": "https://github.com/octo-org",
"followers_url": "https://api.github.com/users/octo-org/followers",
"following_url": "https://api.github.com/users/octo-org/following{/other_user}",
"gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
"organizations_url": "https://api.github.com/users/octo-org/orgs",
"repos_url": "https://api.github.com/users/octo-org/repos",
"events_url": "https://api.github.com/users/octo-org/events{/privacy}",
"received_events_url": "https://api.github.com/users/octo-org/received_events",
"type": "Organization",
"site_admin": false
},
"repository_selection": "selected",
"access_tokens_url": "https://api.github.com/app/installations/25381/access_tokens",
"repositories_url": "https://api.github.com/installation/repositories",
"html_url": "https://github.com/organizations/octo-org/settings/installations/25381",
"app_id": 2218,
"target_id": 6811672,
"target_type": "Organization",
"permissions": {
"deployments": "write",
"metadata": "read",
"pull_requests": "read",
"statuses": "read"
},
"events": [
"deployment",
"deployment_status"
],
"created_at": "2017-05-16T08:47:09.000-07:00",
"updated_at": "2017-06-06T11:23:23.000-07:00",
"single_file_name": "config.yml",
"has_multiple_single_files": true,
"single_file_paths": [
"config.yml",
".github/issue_TEMPLATE.md"
],
"app_slug": "github-actions",
"suspended_at": null,
"suspended_by": null
}
]
}
Link
string
Example
<https://api.github.com/resource?page=2>; rel="next", <https://api.github.com/resource?page=5>; rel="last"