REST API

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

Quickstart

Guides

View all

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.

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.