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
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
/
Overview
Free, Pro, & Team
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
/
Overview
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
Free, Pro, & Team
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
Â
REST API overview
Learn about resources, libraries, previews and troubleshooting for GitHub's REST API.
Resources in the REST API
Media types
Other authentication methods
Troubleshooting
Libraries
OpenAPI description
Endpoints available for GitHub Apps
Permissions required for GitHub Apps