OpenAPI 3.0.3MITraw.githubusercontent.com2026-08-061,4651,08313.3 MB

dc0584ac4e13

apps

Get the authenticated app

Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the installations_count in the response. For more details about your app's installations, see the "List installations for the authenticated app" endpoint.

You must use a JWT to access this endpoint.

get/app

Response

idinteger required

Unique identifier of the GitHub app

slugstring

The slug name of the GitHub app

node_idstring required

client_idstring

namestring required

The name of the GitHub app

descriptionstring nullable required

external_urlstring uri required

html_urlstring uri required

created_atstring date-time required

updated_atstring date-time required

eventsstring[] 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_countinteger

The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.

Example response

{
  "id": 37,
  "slug": "probot-owners",
  "node_id": "MDExOkludGVncmF0aW9uMQ==",
  "client_id": "\"Iv1.25b5d1e65ffc4022\"",
  "owner": {
    "login": "octocat",
    "id": 1,
    "node_id": "MDQ6VXNlcjE=",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "gravatar_id": "41d064eb2195891e12d0413f63227ea7",
    "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",
    "starred_at": "\"2020-07-09T00:17:55Z\"",
    "user_view_type": "public"
  },
  "name": "Probot Owners",
  "description": "The description of the app.",
  "external_url": "https://example.com",
  "html_url": "https://github.com/apps/super-ci",
  "created_at": "2017-07-08T16:18:44-04:00",
  "updated_at": "2017-07-08T16:18:44-04:00",
  "permissions": {
    "issues": "read",
    "deployments": "write"
  },
  "events": [
    "label",
    "deployment"
  ],
  "installations_count": 5
}