Skip to main content
GitHub Docs
Version:
Free, Pro, & Team
Search or ask Copilot
Search or ask
Copilot
Select language: current language is English
Search or ask Copilot
Search or ask
Copilot
Open menu
Collapse sidebar
Expand sidebar
Scroll breadcrumbs left
Home
REST API
Using the REST API
Getting started
Scroll breadcrumbs right
REST API
API Version:
2026-03-10 (latest)
Quickstart
About the REST API
About the REST API
Comparing GitHub's APIs
API Versions
Breaking changes
OpenAPI description
Using the REST API
Getting started
Rate limits
Pagination
Libraries
Best practices
Troubleshooting
Timezones
CORS and JSONP
Issue event types
GitHub event types
Authentication
Authenticating
Keeping API credentials secure
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
Guides
Script with JavaScript
Script with Ruby
Discover resources for a user
Delivering deployments
Rendering data as graphs
Working with comments
Building a CI server
Get started - Git database
Get started - Checks
Encrypt secrets
Actions
Artifacts
Cache
Actions concurrency groups
GitHub-hosted runners
OIDC
Permissions
Secrets
Self-hosted runner groups
Self-hosted runners
Variables
Workflow jobs
Workflow runs
Workflows
Activity
Events
Feeds
Notifications
Starring
Watching
Agent tasks
Agent tasks
Agents
Secrets
Variables
Apps
GitHub Apps
Installations
Marketplace
OAuth authorizations
Webhooks
Billing
Budgets
Billing usage
Branches
Branches
Protected branches
Campaigns
Security campaigns
Checks
Check runs
Check suites
Classroom
Classroom
Code quality
Code quality
Code scanning
Code scanning
Code security settings
Configurations
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
Cloud agent repository management
Copilot cloud agent management
Copilot content exclusion management
Copilot usage metrics
Copilot user management
Copilot Spaces
Collaborators
Copilot Spaces
Resources
Credentials
Revocation
Dependabot
Alerts
Repository access
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
Enterprise teams
Enterprise team members
Enterprise team organizations
Enterprise teams
Gists
Gists
Comments
Git database
Blobs
Commits
References
Tags
Trees
Gitignore
Gitignore
Interactions
Organization
Repository
User
Issues
Assignees
Comments
Events
Issue dependencies
Issue field values
Issues
Labels
Milestones
Sub-issues
Timeline
Licenses
Licenses
Markdown
Markdown
Meta
Meta
Metrics
Community
Statistics
Traffic
Migrations
Organizations
Source endpoints
Users
Organizations
API Insights
Artifact metadata
Artifact attestations
Blocking users
Custom properties
Issue fields
Issue types
Members
Network configurations
Organization roles
Organizations
Outside collaborators
Personal access tokens
Rule suites
Rules
Security managers
Webhooks
Packages
Packages
Pages
Pages
Private registries
Organization configurations
Projects
Draft Project items
Project fields
Project items
Projects
Project views
Pull requests
Review comments
Pull requests
Review requests
Reviews
Stacked pull requests
Rate limit
Rate limit
Reactions
Reactions
Releases
Releases
Release assets
Repositories
Attestations
Autolinks
Contents
Custom properties
Forks
Issue types
Repositories
Rule suites
Rules
Webhooks
Search
Search
Secret scanning
Custom patterns
Push protection
Secret scanning
Security advisories
Global security advisories
Repository security advisories
Teams
Members
Teams
Users
Attestations
Blocking users
Emails
Followers
GPG keys
Git SSH keys
Social accounts
SSH signing keys
Users
Getting started with the REST API
Learn how to use the GitHub REST API.
Tool navigation
GitHub CLI
curl
JavaScript
Copy as Markdown
In this article
Introduction
About requests to the REST API