List installations for the authenticated app | GitHub API (unofficial showcase)

4 parameters

per_pageintegeroptional

The number of installations to return per page, up to 100. Defaults to 30 when omitted.

Default:30

pageintegeroptional

The page number of results to retrieve. Defaults to 1 when omitted.

Default:1

sincestringoptional

Return installations last updated after this timestamp, in ISO 8601 date-time format.

outdatedstringoptional

A string-valued filter for outdated installations.

1 status code

200Returns an array of installation objects, including each installation's account, repository selection, and granted permissions.

idintegerrequired

The ID of the installation.

accountobjectrequired

A GitHub user.

repository_selectionstringrequired

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

Allowed:allselected

access_tokens_urlstringrequired

repositories_urlstringrequired

html_urlstringrequired

app_idintegerrequired

client_idstringoptional

target_idintegerrequired

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

target_typestringrequired

permissionsobjectrequired

The permissions granted to the fine-grained access token.

eventsarray<string>required

created_atstringrequired

updated_atstringrequired

single_file_namestringrequired

has_multiple_single_filesbooleanoptional

single_file_pathsarray<string>optional

app_slugstringrequired

suspended_byobjectrequired

A GitHub user.

suspended_atstringrequired

contact_emailstringoptional

Error handling

Authenticate with a GitHub App JWT to access installations. per_page must not exceed 100, and since must use ISO 8601 date-time format.

import { Client } from "@octridev/github";

const client = new Client({
  baseUrl: "https://api.github.com",
});

const result = await client.installations.list({
  perPage: 20,
  page: 1,
  since: "example",
  outdated: "2024-01-15T09:30:00Z",
});

[
  {
    "id": 1,
    "account": {
      "login": "octocat",
      "id": 1,
      "node_id": "MDQ6VXNlcjE=",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "gravatar_id": "",
      "url": "https://api.github.com/users/octocat",
      "html_url": "https://github.com/octocat",
      "followers_url": "https://api.github.com/users/octocat/followers",
      "following_url": "https://api.github.com/users/octocat/following{/other_user}",
      "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
      "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
      "organizations_url": "https://api.github.com/users/octocat/orgs",
      "repos_url": "https://api.github.com/users/octocat/repos",
      "events_url": "https://api.github.com/users/octocat/events{/privacy}",
      "received_events_url": "https://api.github.com/users/octocat/received_events",
      "type": "User",
      "site_admin": false
    },
    "access_tokens_url": "https://api.github.com/app/installations/1/access_tokens",
    "repositories_url": "https://api.github.com/installation/repositories",
    "html_url": "https://github.com/organizations/github/settings/installations/1",
    "app_id": 1,
    "target_id": 1,
    "target_type": "Organization",
    "permissions": {
      "checks": "write",
      "metadata": "read",
      "contents": "read"
    },
    "events": [
      "push",
      "pull_request"
    ],
    "single_file_name": "config.yaml",
    "has_multiple_single_files": true,
    "single_file_paths": [
      "config.yml",
      ".github/issue_TEMPLATE.md"
    ],
    "repository_selection": "selected",
    "created_at": "2017-07-08T16:18:44-04:00",
    "updated_at": "2017-07-08T16:18:44-04:00",
    "app_slug": "github-actions",
    "suspended_at": null,
    "suspended_by": null
  }
]

Request

Response

Errors