GitHub REST API documentation
Create integrations, retrieve data, and automate your workflows with the GitHub REST API.
Start here
View allAbout the REST API
Get oriented to the REST API documentation.
Getting started with the REST API
Learn how to use the GitHub REST API.
Authenticating to the REST API
You can authenticate to the REST API to access more endpoints and have a higher rate limit.
Best practices for using the REST API
Follow these best practices when using GitHub's API.
Popular
Rate limits for the REST API
Learn about REST API rate limits, how to avoid exceeding them, and what to do if you do exceed them.
Troubleshooting the REST API
Learn how to diagnose and resolve common problems for the REST API.
Scripting with the REST API and JavaScript
Write a script using the Octokit.js SDK to interact with the REST API.
Keeping your API credentials secure
Follow these best practices to keep your API credentials and tokens secure.
Delivering deployments
Using the Deployments REST API, you can build custom tooling that interacts with your server and a third-party app.
Using the REST API to interact with checks
You can use the REST API to build GitHub Apps that run powerful checks against code changes in a repository. You can create apps that perform continuous integration, code linting, or code scanning services and provide detailed feedback on commits.
Using pagination in the REST API
Learn how to navigate through paginated responses from the REST API.
Authenticating to the REST API
- Authenticating to the REST API
- Keeping your API credentials secure
- 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
Guides
- Scripting with the REST API and JavaScript
- Scripting with the REST API and Ruby
- Discovering resources for a user
- Delivering deployments
- Rendering data as graphs
- Working with comments
- Building a CI server
- Using the REST API to interact with your Git database
- Using the REST API to interact with checks
- Encrypting secrets for the REST API
REST API endpoints for GitHub Actions
- REST API endpoints for GitHub Actions artifacts
- REST API endpoints for GitHub Actions cache
- GitHub-hosted runners
- REST API endpoints for GitHub Actions OIDC
- REST API endpoints for GitHub Actions permissions
- REST API endpoints for GitHub Actions Secrets
- REST API endpoints for self-hosted runner groups
- REST API endpoints for self-hosted runners
- REST API endpoints for GitHub Actions variables
- REST API endpoints for workflow jobs
- REST API endpoints for workflow runs
- REST API endpoints for workflows
REST API endpoints for issues
- REST API endpoints for issue assignees
- REST API endpoints for issue comments
- REST API endpoints for issue events
- REST API endpoints for issues
- REST API endpoints for issue dependencies
- REST API endpoints for labels
- REST API endpoints for milestones
- REST API endpoints for sub-issues
- REST API endpoints for timeline events
REST API endpoints for organizations
- REST API endpoints for API Insights
- Artifact metadata
- REST API endpoints for artifact attestations
- REST API endpoints for blocking users
- REST API endpoints for custom properties
- REST API endpoints for issue types
- REST API endpoints for organization members
- REST API endpoints for network configurations
- REST API endpoints for organization roles
- REST API endpoints for organizations
- REST API endpoints for outside collaborators
- REST API endpoints for personal access tokens
- REST API endpoints for rule suites
- REST API endpoints for rules
- REST API endpoints for security managers
- REST API endpoints for organization webhooks
REST API endpoints for repositories
- REST API endpoints for repository autolinks
- REST API endpoints for repository contents
- REST API endpoints for custom properties
- REST API endpoints for forks
- REST API endpoints for repositories
- REST API endpoints for rule suites
- REST API endpoints for rules
- REST API endpoints for repository tags
- REST API endpoints for repository webhooks
REST API endpoints for users
- REST API endpoints for artifact attestations
- REST API endpoints for blocking users
- REST API endpoints for emails
- REST API endpoints for followers
- REST API endpoints for GPG keys
- REST API endpoints for Git SSH keys
- REST API endpoints for social accounts
- REST API endpoints for SSH signing keys
- REST API endpoints for users