Skip to main content
Manja / GitHub

List app installations for an organization

Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with `admin:read` scope to use this endpoint.

GET/orgs/{org}/installations
Source
github-v3-rest.json
Revision
f5f067c1e6f6
Active snapshot
85e53e3d0d65

Request

Path Parameters
org string
required
Query Parameters
per_page integer
optional

Results per page (max 100)

page integer
optional

Page number of the results to fetch.

Responses

application/json object

Response

Headers
Link string
Example:
<https://api.github.com/resource?page=2>; rel="next", <https://api.github.com/resource?page=5>; rel="last"
installations array[Installation object]
required
items Installation object

Installation

access_tokens_url string<uri>
required

Example: https://api.github.com/installations/1/access_tokens

account
requirednullable
app_id integer
required

Example: 1

app_slug string
required

Example: github-actions

contact_email string
optionalnullable

Example: "[email protected]"

created_at string<date-time>
required
events array[string]
required
has_multiple_single_files boolean
optional

Example: true

html_url string<uri>
required

Example: https://github.com/organizations/github/settings/installations/1

id integer
required

The ID of the installation.

Example: 1

permissions App Permissions object
required

The permissions granted to the user-to-server access token.

Example:
{
  "contents": "read",
  "deployments": "write",
  "issues": "read",
  "single_file": "read"
}
actions string
optional

The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts. Can be one of: `read` or `write`.

Allowed: "read""write"

administration string
optional

The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation. Can be one of: `read` or `write`.

Allowed: "read""write"

checks string
optional

The level of permission to grant the access token for checks on code. Can be one of: `read` or `write`.

Allowed: "read""write"

content_references string
optional

The level of permission to grant the access token for notification of content references and creation content attachments. Can be one of: `read` or `write`.

Allowed: "read""write"

contents string
optional

The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges. Can be one of: `read` or `write`.

Allowed: "read""write"

deployments string
optional

The level of permission to grant the access token for deployments and deployment statuses. Can be one of: `read` or `write`.

Allowed: "read""write"

environments string
optional

The level of permission to grant the access token for managing repository environments. Can be one of: `read` or `write`.

Allowed: "read""write"

issues string
optional

The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones. Can be one of: `read` or `write`.

Allowed: "read""write"

members string
optional

The level of permission to grant the access token for organization teams and members. Can be one of: `read` or `write`.

Allowed: "read""write"

metadata string
optional

The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata. Can be one of: `read` or `write`.

Allowed: "read""write"

organization_administration string
optional

The level of permission to grant the access token to manage access to an organization. Can be one of: `read` or `write`.

Allowed: "read""write"

organization_hooks string
optional

The level of permission to grant the access token to manage the post-receive hooks for an organization. Can be one of: `read` or `write`.

Allowed: "read""write"

organization_packages string
optional

The level of permission to grant the access token for organization packages published to GitHub Packages. Can be one of: `read` or `write`.

Allowed: "read""write"

organization_plan string
optional

The level of permission to grant the access token for viewing an organization's plan. Can be one of: `read`.

Allowed: "read"

organization_projects string
optional

The level of permission to grant the access token to manage organization projects and projects beta (where available). Can be one of: `read`, `write`, or `admin`.

Allowed: "read""write""admin"

organization_secrets string
optional

The level of permission to grant the access token to manage organization secrets. Can be one of: `read` or `write`.

Allowed: "read""write"

organization_self_hosted_runners string
optional

The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization. Can be one of: `read` or `write`.

Allowed: "read""write"

organization_user_blocking string
optional

The level of permission to grant the access token to view and manage users blocked by the organization. Can be one of: `read` or `write`.

Allowed: "read""write"

packages string
optional

The level of permission to grant the access token for packages published to GitHub Packages. Can be one of: `read` or `write`.

Allowed: "read""write"

pages string
optional

The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds. Can be one of: `read` or `write`.

Allowed: "read""write"

pull_requests string
optional

The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges. Can be one of: `read` or `write`.

Allowed: "read""write"

repository_hooks string
optional

The level of permission to grant the access token to manage the post-receive hooks for a repository. Can be one of: `read` or `write`.

Allowed: "read""write"

repository_projects string
optional

The level of permission to grant the access token to manage repository projects, columns, and cards. Can be one of: `read`, `write`, or `admin`.

Allowed: "read""write""admin"

secret_scanning_alerts string
optional

The level of permission to grant the access token to view and manage secret scanning alerts. Can be one of: `read` or `write`.

Allowed: "read""write"

secrets string
optional

The level of permission to grant the access token to manage repository secrets. Can be one of: `read` or `write`.

Allowed: "read""write"

security_events string
optional

The level of permission to grant the access token to view and manage security events like code scanning alerts. Can be one of: `read` or `write`.

Allowed: "read""write"

single_file string
optional

The level of permission to grant the access token to manage just a single file. Can be one of: `read` or `write`.

Allowed: "read""write"

statuses string
optional

The level of permission to grant the access token for commit statuses. Can be one of: `read` or `write`.

Allowed: "read""write"

team_discussions string
optional

The level of permission to grant the access token to manage team discussions and related comments. Can be one of: `read` or `write`.

Allowed: "read""write"

vulnerability_alerts string
optional

The level of permission to grant the access token to manage Dependabot alerts. Can be one of: `read` or `write`.

Allowed: "read""write"

workflows string
optional

The level of permission to grant the access token to update GitHub Actions workflow files. Can be one of: `write`.

Allowed: "write"

repositories_url string<uri>
required

Example: https://api.github.com/installation/repositories

repository_selection string
required

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

Allowed: "all""selected"

single_file_name string
requirednullable

Example: config.yaml

single_file_paths array[string]
optional
Example:
[
  "config.yml",
  ".github/issue_TEMPLATE.md"
]
suspended_at string<date-time>
requirednullable
suspended_by Simple User object
requirednullable

Simple User

avatar_url string<uri>
required

Example: https://github.com/images/error/octocat_happy.gif

email string
optionalnullable
events_url string
required

Example: https://api.github.com/users/octocat/events{/privacy}

followers_url string<uri>
required

Example: https://api.github.com/users/octocat/followers

following_url string
required

Example: https://api.github.com/users/octocat/following{/other_user}

gists_url string
required

Example: https://api.github.com/users/octocat/gists{/gist_id}

gravatar_id string
requirednullable

Example: 41d064eb2195891e12d0413f63227ea7

html_url string<uri>
required

Example: https://github.com/octocat

id integer
required

Example: 1

login string
required

Example: octocat

name string
optionalnullable
node_id string
required

Example: MDQ6VXNlcjE=

organizations_url string<uri>
required

Example: https://api.github.com/users/octocat/orgs

received_events_url string<uri>
required

Example: https://api.github.com/users/octocat/received_events

repos_url string<uri>
required

Example: https://api.github.com/users/octocat/repos

site_admin boolean
required
starred_at string
optional

Example: "2020-07-09T00:17:55Z"

starred_url string
required

Example: https://api.github.com/users/octocat/starred{/owner}{/repo}

subscriptions_url string<uri>
required

Example: https://api.github.com/users/octocat/subscriptions

type string
required

Example: User

url string<uri>
required

Example: https://api.github.com/users/octocat

target_id integer
required

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

target_type string
required

Example: Organization

updated_at string<date-time>
required
total_count integer
required