Skip to main content
GitHub Docs
All products
REST API
Overview
Resources in the REST API
Media types
Other authentication methods
Troubleshooting
Libraries
OpenAPI description
GitHub App-enabled endpoints
GitHub App permissions
Guides
Get started - REST API
Basics of authentication
Discover resources for a user
Delivering deployments
Rendering data as graphs
Working with comments
Traverse with pagination
Building a CI server
Integrator best practices
Get started - Git Database API
Get started - Checks API
REST API reference
Actions
Artifacts
Cache
OIDC
Permissions
Secrets
Self-hosted runner groups
Self-hosted runners
Workflow jobs
Workflow runs
Workflows
Activity
Events
Feeds
Notifications
Starring
Watching
Apps
GitHub Apps
Installations
Marketplace
OAuth Apps
Webhooks
Billing
Branches
Branches
Protected branches
Checks
Check Runs
Check Suites
Codes of conduct
Code Scanning
Codespaces
Codespaces
Organizations
Machines
Repository secrets
User secrets
Collaborators
Collaborators
Invitations
Commits
Commits
Commit comments
Commit statuses
Dependabot
Secrets
Dependency Graph
Dependency review
Dependency submission
Deploy keys
Deployments
Deployments
Environments
Deployment Statuses
Emojis
Enterprise administration
Admin stats
Audit log
Billing
SCIM
Gists
Gists
Comments
Git database
Blobs
Commits
References
Tags
Trees
Gitignore
Interactions
Organization
Repository
User
Issues
Issues
Assignees
Comments
Events
Labels
Milestones
Timeline
Licenses
Markdown
Meta
Metrics
Community
Statistics
Traffic
Migrations
Organizations
Source imports
Users
OAuth authorizations
Organizations
Organizations
Blocking users
Custom Repository Roles
Members
Outside Collaborators
Webhooks
Packages
Pages
Projects
Boards
Cards
Collaborators
Columns
Pulls
Pulls
Review comments
Review requests
Reviews
Rate limit
Reactions
Releases
Releases
Release Assets
Repositories
Repositories
Autolinks
Contents
Forks
Git LFS
Tags
SCIM
Search
Secret scanning
Teams
Teams
Discussion comments
Discussions
External groups
Members
Team synchronization
Users
Users
Blocking users
Emails
Followers
GPG Keys
Git SSH Keys
Webhooks
Repository Webhook Configuration
Repository Webhook Deliveries
Repository Webhooks
REST API
/
Users
Enterprise Cloud
Free, Pro, & Team
Enterprise Cloud
Enterprise Server 3.5
Enterprise Server 3.4
Enterprise Server 3.3
Enterprise Server 3.2
Enterprise Server 3.1
GitHub AE
All Enterprise Server releases
About versions
English
English
简体中文
(
Simplified Chinese
)
日本語
(
Japanese
)
Español
(
Spanish
)
Português do Brasil
(
Portuguese
)
Sign up
Search GitHub Docs
GitHub Docs
REST API
/
Users
REST API
Get started
Account and profile
Authentication
Repositories
Enterprise administrators
Billing and payments
Site policy
Organizations
Code security
Pull requests
GitHub Issues
GitHub Actions
GitHub Copilot
GitHub Codespaces
GitHub Packages
Search on GitHub
Developers
REST API
GraphQL API
GitHub CLI
GitHub Discussions
GitHub Sponsors
Building communities
GitHub Pages
Education
GitHub Desktop
GitHub Support
Atom
Electron
CodeQL
npm
Enterprise Cloud
Free, Pro, & Team
Enterprise Cloud
Enterprise Server 3.5
Enterprise Server 3.4
Enterprise Server 3.3
Enterprise Server 3.2
Enterprise Server 3.1
GitHub AE
All Enterprise Server releases
About versions
English
English
简体中文
(
Simplified Chinese
)
日本語
(
Japanese
)
Español
(
Spanish
)
Português do Brasil
(
Portuguese
)
Sign up
Search GitHub Docs
Users
The Users API allows to get public and private information about the authenticated user.
Users
Get the authenticated user
Update the authenticated user
List users
Get a user
Get contextual information for a user
Blocking users
List users blocked by the authenticated user
Check if a user is blocked by the authenticated user
Block a user
Unblock a user
Emails
Set primary email visibility for the authenticated user
List email addresses for the authenticated user
Add an email address for the authenticated user
Delete an email address for the authenticated user
List public email addresses for the authenticated user
Followers
List followers of the authenticated user
List the people the authenticated user follows
Check if a person is followed by the authenticated user
Follow a user
Unfollow a user
List followers of a user
List the people a user follows
Check if a user follows another user
GPG Keys
List GPG keys for the authenticated user
Create a GPG key for the authenticated user
Get a GPG key for the authenticated user
Delete a GPG key for the authenticated user
List GPG keys for a user
Git SSH Keys
List public SSH keys for the authenticated user
Create a public SSH key for the authenticated user
Get a public SSH key for the authenticated user
Delete a public SSH key for the authenticated user
List public keys for a user