# Get a user installation for the authenticated app

From **GitHub v3 REST API**.

`GET /users/{username}/installation`

Enables an authenticated GitHub App to find the user’s installation information.

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.

## Parameters

### `username`

- Location: path
- Required: true
- Type: `string`

## Responses

### `200`

Response

### `application/json`

- Type: `object`

Installation

```json
{
  "access_tokens_url": "https://api.github.com/installations/1/access_tokens",
  "account": {
    "avatar_url": "https://github.com/images/error/hubot_happy.gif",
    "events_url": "https://api.github.com/orgs/github/events",
    "followers_url": "https://api.github.com/users/github/followers",
    "following_url": "https://api.github.com/users/github/following{/other_user}",
    "gists_url": "https://api.github.com/users/github/gists{/gist_id}",
    "gravatar_id": "",
    "html_url": "https://github.com/github",
    "id": 1,
    "login": "github",
    "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
    "organizations_url": "https://api.github.com/users/github/orgs",
    "received_events_url": "https://api.github.com/users/github/received_events",
    "repos_url": "https://api.github.com/orgs/github/repos",
    "site_admin": false,
    "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}",
    "subscriptions_url": "https://api.github.com/users/github/subscriptions",
    "type": "Organization",
    "url": "https://api.github.com/orgs/github"
  },
  "app_id": 1,
  "app_slug": "github-actions",
  "created_at": "2018-02-09T20:51:14Z",
  "events": [
    "push",
    "pull_request"
  ],
  "has_multiple_single_files": true,
  "html_url": "https://github.com/organizations/github/settings/installations/1",
  "id": 1,
  "permissions": {
    "checks": "write",
    "contents": "read",
    "metadata": "read"
  },
  "repositories_url": "https://api.github.com/installation/repositories",
  "repository_selection": "all",
  "single_file_name": "config.yml",
  "single_file_paths": [
    "config.yml",
    ".github/issue_TEMPLATE.md"
  ],
  "suspended_at": null,
  "suspended_by": null,
  "target_id": 1,
  "target_type": "Organization",
  "updated_at": "2018-02-09T20:51:14Z"
}
```

```json
{"description":"Installation","properties":{"access_tokens_url":{"example":"https://api.github.com/installations/1/access_tokens","format":"uri","type":"string"},"account":{"anyOf":[{"$ref":"#/components/schemas/simple-user"},{"$ref":"#/components/schemas/enterprise"}],"nullable":true},"app_id":{"example":1,"type":"integer"},"app_slug":{"example":"github-actions","type":"string"},"contact_email":{"example":"\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"","nullable":true,"type":"string"},"created_at":{"format":"date-time","type":"string"},"events":{"items":{"type":"string"},"type":"array"},"has_multiple_single_files":{"example":true,"type":"boolean"},"html_url":{"example":"https://github.com/organizations/github/settings/installations/1","format":"uri","type":"string"},"id":{"description":"The ID of the installation.","example":1,"type":"integer"},"permissions":{"$ref":"#/components/schemas/app-permissions"},"repositories_url":{"example":"https://api.github.com/installation/repositories","format":"uri","type":"string"},"repository_selection":{"description":"Describe whether all repositories have been selected or there's a selection involved","enum":["all","selected"],"type":"string"},"single_file_name":{"example":"config.yaml","nullable":true,"type":"string"},"single_file_paths":{"example":["config.yml",".github/issue_TEMPLATE.md"],"items":{"type":"string"},"type":"array"},"suspended_at":{"format":"date-time","nullable":true,"type":"string"},"suspended_by":{"$ref":"#/components/schemas/nullable-simple-user"},"target_id":{"description":"The ID of the user or organization this token is being scoped to.","type":"integer"},"target_type":{"example":"Organization","type":"string"},"updated_at":{"format":"date-time","type":"string"}},"required":["id","app_id","app_slug","target_id","target_type","single_file_name","repository_selection","access_tokens_url","html_url","repositories_url","events","account","permissions","created_at","updated_at","suspended_by","suspended_at"],"title":"Installation","type":"object"}
```

## Request examples

### cURL

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