The Wayback Machine - https://web.archive.org/web/20211225091743/https://docs.github.com/en/rest

Free, Pro, & Team

English

REST API

To create integrations, retrieve data, and automate your workflows, build with the GitHub REST API.

Guides

Getting started with the REST API

Learn the foundations for using the REST API, starting with authentication and some endpoint examples.

Basics of authentication

Learn about the different ways to authenticate with some examples.

Best practices for integrators

Build an app that reliably interacts with the GitHub API and provides the best experience for your users.

Popular

Resources in the REST API

Other authentication methods

Troubleshooting

Endpoints available for GitHub Apps

OpenAPI description

What's new

OpenAPI Description of REST API is now 3.1 compliant

Improvements to the code scanning API

API support for managing labels of Actions self-hosted runners

Guides

Delivering deployments

Using the Deployments REST API, you can build custom tooling that interacts with your server and a third-party app.

Getting started with the Checks API

The Check Runs API enables you 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.

Traversing with pagination

Explore how to use pagination to manage your responses with some examples using the Search API.

All REST API docs

REST API overview

Resources in the REST API

Other authentication methods

Troubleshooting

Guides

Getting started with the REST API

Basics of authentication

Discovering resources for a user

Delivering deployments

Rendering data as graphs

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

Or, learn how to contribute.

Still need help?

Ask the GitHub community

Contact support