---
title: "Get the authenticated user"
method: GET
path: "/user"
tags: ["users"]
---

# Get the authenticated user

`GET /user`

If the authenticated user is authenticated with an OAuth token with the `user` scope, then the response lists public and private profile information.

If the authenticated user is authenticated through OAuth without the `user` scope, then the response lists only public profile information.

## Response `200`

Response

- union
  - PrivateUser — Private User
    - `login` string, required
    - `id` integer, required
    - `node_id` string, required
    - `avatar_url` string, uri, required
    - `gravatar_id` string, nullable, required
    - `url` string, uri, required
    - `html_url` string, uri, required
    - `followers_url` string, uri, required
    - `following_url` string, required
    - `gists_url` string, required
    - `starred_url` string, required
    - `subscriptions_url` string, uri, required
    - `organizations_url` string, uri, required
    - `repos_url` string, uri, required
    - `events_url` string, required
    - `received_events_url` string, uri, required
    - `type` string, required
    - `site_admin` boolean, required
    - `name` string, nullable, required
    - `company` string, nullable, required
    - `blog` string, nullable, required
    - `location` string, nullable, required
    - `email` string, email, nullable, required
    - `hireable` boolean, nullable, required
    - `bio` string, nullable, required
    - `twitter_username` string, nullable
    - `public_repos` integer, required
    - `public_gists` integer, required
    - `followers` integer, required
    - `following` integer, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
    - `private_gists` integer, required
    - `total_private_repos` integer, required
    - `owned_private_repos` integer, required
    - `disk_usage` integer, required
    - `collaborators` integer, required
    - `two_factor_authentication` boolean, required
    - `plan` object
      - `collaborators` integer, required
      - `name` string, required
      - `space` integer, required
      - `private_repos` integer, required
    - `suspended_at` string, date-time, nullable
    - `business_plus` boolean
    - `ldap_dn` string
  - PublicUser — Public User
    - `login` string, required
    - `id` integer, required
    - `node_id` string, required
    - `avatar_url` string, uri, required
    - `gravatar_id` string, nullable, required
    - `url` string, uri, required
    - `html_url` string, uri, required
    - `followers_url` string, uri, required
    - `following_url` string, required
    - `gists_url` string, required
    - `starred_url` string, required
    - `subscriptions_url` string, uri, required
    - `organizations_url` string, uri, required
    - `repos_url` string, uri, required
    - `events_url` string, required
    - `received_events_url` string, uri, required
    - `type` string, required
    - `site_admin` boolean, required
    - `name` string, nullable, required
    - `company` string, nullable, required
    - `blog` string, nullable, required
    - `location` string, nullable, required
    - `email` string, email, nullable, required
    - `hireable` boolean, nullable, required
    - `bio` string, nullable, required
    - `twitter_username` string, nullable
    - `public_repos` integer, required
    - `public_gists` integer, required
    - `followers` integer, required
    - `following` integer, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
    - `plan` object
      - `collaborators` integer, required
      - `name` string, required
      - `space` integer, required
      - `private_repos` integer, required
    - `suspended_at` string, date-time, nullable
    - `private_gists` integer
    - `total_private_repos` integer
    - `owned_private_repos` integer
    - `disk_usage` integer
    - `collaborators` integer

## Other responses

- `304` — Not modified
- `401` — Requires authentication
- `403` — Forbidden

---

[API](https://skmtc.net/github/apis/github-v3-rest-api-6.md) · [All operations](https://skmtc.net/github/apis/github-v3-rest-api-6/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/github/github-v3-rest-api-6/versions/15db3fa0759b/schema)