Skip to main content
GitHub Docs
Version:
Free, Pro, & Team
Search GitHub Docs
REST API
/
Overview
Home
REST API
API Version:
2022-11-28 (latest)
Quickstart
Overview
Comparing GitHub's APIs
Resources in the REST API
Rate limits
API Versions
Media types
Authenticating
Keeping API credentials secure
Troubleshooting
Libraries
OpenAPI description
Issue event types
GitHub event types
Endpoints for GitHub App installation tokens
Endpoints for GitHub App user tokens
Endpoints for fine-grained PATs
Permissions for GitHub Apps
Permissions for fine-grained PATs
Breaking changes
Guides
Using the API
Script with JavaScript
Script with Ruby
Discover resources for a user
Delivering deployments
Rendering data as graphs
Working with comments
Pagination
Building a CI server
Best practices
Get started - Git database
Get started - Checks
Encrypt secrets
Actions
Artifacts
Cache
OIDC
Permissions
Secrets
Self-hosted runners
Variables
Workflow jobs
Workflow runs
Workflows
Activity
Events
Feeds
Notifications
Starring
Watching
Apps
GitHub Apps
Installations
Marketplace
OAuth Authorizations
Webhooks
Billing
Billing
Branches
Branches
Protected branches
Checks
Check Runs
Check Suites
Classroom
Classroom
Code Scanning
Code Scanning
Codes of conduct
Codes of conduct
Codespaces
Codespaces
Organizations
Organization secrets
Machines
Repository secrets
User secrets
Collaborators
Collaborators
Invitations
Commits
Commits
Commit comments
Commit statuses
Copilot
Copilot business
Dependabot
Alerts
Secrets
Dependency Graph
Dependency review
Dependency submission
Software bill of materials (SBOM)
Deploy keys
Deploy keys
Deployments
Deployment branch policies
Deployments
Environments
Protection rules
Deployment statuses
Emojis
Emojis
Gists
Gists
Comments
Git database
Blobs
Commits
References
Tags
Trees
Gitignore
Gitignore
Interactions
Organization
Repository
User
Issues
Issues
Assignees
Comments
Events
Labels
Milestones
Timeline
Licenses
Licenses
Markdown
Markdown
Meta
Meta
Metrics
Community
Statistics
Traffic
Migrations
Organizations
Source imports
Users
Organizations
Blocking users
Custom properties
Members
Organization roles
Organizations
Outside Collaborators
Personal access tokens
Rule Suites
Rules
Security Managers
Webhooks
Packages
Packages
Pages
Pages
Projects (classic)
Boards
Cards
Collaborators
Columns
Pulls
Pulls
Review comments
Review requests
Reviews
Rate limit
Rate limit
Reactions
Reactions
Releases
Releases
Release Assets
Repositories
Autolinks
Contents
Custom properties
Forks
Repositories
Rule Suites
Rules
Tags
Webhooks
Search
Search
Secret scanning
Secret scanning
Security advisories
Global security advisories
Repository security advisories
Teams
Teams
Discussion comments
Discussions
Members
Users
Users
Blocking users
Emails
Followers
GPG Keys
Git SSH Keys
SSH signing keys
Social accounts
REST API
/
Overview
REST API overview
Learn about resources, libraries, previews and troubleshooting for GitHub's REST API.
Comparing GitHub's REST API and GraphQL API
Resources in the REST API
Rate limits for the REST API
API Versions
Media types
Authenticating to the REST API
Keeping your API credentials secure
Troubleshooting the REST API
Libraries for the REST API
About the OpenAPI description for the REST API
Issue event types
GitHub event types
Endpoints available for GitHub App installation access tokens
Endpoints available for GitHub App user access tokens
Endpoints available for fine-grained personal access tokens
Permissions required for GitHub Apps
Permissions required for fine-grained personal access tokens
Breaking changes