Sample - GitHub REST API
GET/apps/{app_slug}

Get a GitHub App

Retrieves a GitHub App by its URL-friendly slug. Use app_slug from the GitHub App settings URL to identify the app and inspect its metadata, permissions, events, and installation count when available.

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

1 parameter
app_slugstringrequired
The URL-friendly name of the GitHub App, taken from its settings URL.

3 status codes
200Returns the GitHub App object, including its identifier, slug, owner, name, URLs, timestamps, permissions, supported events, and installation count when the integration is requesting its own details.
idintegerrequired
Unique identifier of the GitHub app
slugstringoptional
The slug name of the GitHub app
node_idstringrequired
client_idstringoptional
ownerobjectrequired
A GitHub user.
namestringrequired
The name of the GitHub app
descriptionstringrequired
external_urlstringrequired
html_urlstringrequired
created_atstringrequired
updated_atstringrequired
permissionsobjectrequired
The set of permissions for the GitHub app
eventsarray<string>required
The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.
installations_countintegeroptional
The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.
403Returned when the authenticated user is not permitted to access the GitHub App.
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
404Returned when no GitHub App exists with the specified `app_slug`.
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional

Error handling

A 403 is returned when the authenticated user cannot access the requested GitHub App. A 404 is returned when no GitHub App exists with the specified app_slug.