Sample - GitHub REST API
GET/app/installations

List installations for the authenticated GitHub App

Lists the installations associated with the authenticated GitHub App. Use page and per_page to paginate the results, and use since to return installations updated after a specified timestamp. Each installation includes its granted permissions.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

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 installations to retrieve. Defaults to 1 when omitted.
Default:1
sincestringoptional
Return installations updated after this timestamp in ISO 8601 date-time format.
outdatedstringoptional
A string value used to control whether outdated installations are included.

1 status code
200Returns an array of installation objects, including installation identifiers, target account and type, repository selection, URLs, events, timestamps, 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

Use a JWT to authenticate the request. per_page must not exceed 100, page defaults to 1, and since must be an ISO 8601 date-time when supplied.