# Get the authenticated app

From **GitHub v3 REST API**.

`GET /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](https://docs.github.com/enterprise-server@3.0/rest/reference/apps#list-installations-for-the-authenticated-app)" endpoint.

You must use a [JWT](https://docs.github.com/enterprise-server@3.0/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.

## Responses

### `200`

Response

### `application/json`

- Type: `object`

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

```json
{
  "created_at": "2017-07-08T16:18:44-04:00",
  "description": "",
  "events": [
    "push",
    "pull_request"
  ],
  "external_url": "https://example.com",
  "html_url": "https://github.com/apps/octoapp",
  "id": 1,
  "name": "Octocat App",
  "node_id": "MDExOkludGVncmF0aW9uMQ==",
  "owner": {
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "events_url": "https://api.github.com/orgs/github/events",
    "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}",
    "gravatar_id": "",
    "html_url": "https://github.com/octocat",
    "id": 1,
    "login": "github",
    "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
    "organizations_url": "https://api.github.com/users/octocat/orgs",
    "received_events_url": "https://api.github.com/users/octocat/received_events",
    "repos_url": "https://api.github.com/orgs/github/repos",
    "site_admin": true,
    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
    "type": "User",
    "url": "https://api.github.com/orgs/github"
  },
  "permissions": {
    "contents": "read",
    "issues": "write",
    "metadata": "read",
    "single_file": "write"
  },
  "slug": "octoapp",
  "updated_at": "2017-07-08T16:18:44-04:00"
}
```

```json
{"description":"GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.","properties":{"client_id":{"example":"\"Iv1.25b5d1e65ffc4022\"","type":"string"},"client_secret":{"example":"\"1d4b2097ac622ba702d19de498f005747a8b21d3\"","type":"string"},"created_at":{"example":"2017-07-08T16:18:44-04:00","format":"date-time","type":"string"},"description":{"example":"The description of the app.","nullable":true,"type":"string"},"events":{"description":"The list of events for the GitHub app","example":["label","deployment"],"items":{"type":"string"},"type":"array"},"external_url":{"example":"https://example.com","format":"uri","type":"string"},"html_url":{"example":"https://github.com/apps/super-ci","format":"uri","type":"string"},"id":{"description":"Unique identifier of the GitHub app","example":37,"type":"integer"},"installations_count":{"description":"The number of installations associated with the GitHub app","example":5,"type":"integer"},"name":{"description":"The name of the GitHub app","example":"Probot Owners","type":"string"},"node_id":{"example":"MDExOkludGVncmF0aW9uMQ==","type":"string"},"owner":{"$ref":"#/components/schemas/nullable-simple-user"},"pem":{"example":"\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"","type":"string"},"permissions":{"additionalProperties":{"type":"string"},"description":"The set of permissions for the GitHub app","example":{"deployments":"write","issues":"read"},"properties":{"checks":{"type":"string"},"contents":{"type":"string"},"deployments":{"type":"string"},"issues":{"type":"string"},"metadata":{"type":"string"}},"type":"object"},"slug":{"description":"The slug name of the GitHub app","example":"probot-owners","type":"string"},"updated_at":{"example":"2017-07-08T16:18:44-04:00","format":"date-time","type":"string"},"webhook_secret":{"example":"\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"","nullable":true,"type":"string"}},"required":["id","node_id","owner","name","description","external_url","html_url","created_at","updated_at","permissions","events"],"title":"GitHub app","type":"object"}
```

## Request examples

### cURL

```shell
curl --request GET \
  --url {protocol}://{hostname}/api/v3/app
```
