The GitHub REST API is fully described in an OpenAPI compliant document.

Each REST API endpoint is documented individually, and the endpoints are categorized by the resource that they primarily affect.

The HTTP method of an endpoint defines the type of action it performs on a given resource. Some common HTTP methods are GET, POST, DELETE, and PATCH. The REST API reference documentation provides the HTTP method for every endpoint.

Use octokit.request to execute your request. Send the HTTP method and path as the first argument. Specify any path, query, and body parameters in an object as the second argument.

The GitHub REST API is fully described in an OpenAPI compliant document.

Use the REST API to create, manage and control the workflow of public and private GitHub repositories.

Use the REST API to create, modify, and delete Base64 encoded content in a repository.

You can make API requests across domains using cross-origin resource sharing (CORS) and JSONP callbacks. For the REST APIs for issue events and timeline events, learn about each event type, the triggering action on GitHub, and each event's unique ...

Each REST API endpoint is documented individually, and the endpoints are categorized by the resource that they primarily affect.

GitHub REST API documentation · shortTitle · REST API · intro · Create integrations, retrieve data, and automate your workflows with the {% data variables.product.prodname_dotcom %} REST API. introLinks · overview · quickstart · /rest/about-the-rest-api/about-the-rest-api ·

Once signed in, head over to the GitHub REST API documentation for version 3 at https://developer.github.com/v3/.

Go faster from development to production with higher accuracy and fewer tokens.

July 23, 2025 - X-GitHub-Api-Version: Indicates the API version. User-Agent: Identifies the request origin; required for all requests. ... If the User-Agent header is missing or invalid, GitHub will reject the request with a 403 Forbidden response. The Accept header allows you to specify one or more media types that dictate the format of the response. The default media type for most GitHub REST API requests is application/vnd.github+json.

The HTTP method of an endpoint defines the type of action it performs on a given resource. Some common HTTP methods are GET, POST, DELETE, and PATCH. The REST API reference documentation provides the HTTP method for every endpoint.

Use the REST API to retrieve information about GitHub Apps and GitHub App installations.

Use the REST API to get public and private information about authenticated users.

Pull requests are a type of issue. Any actions that are available in both pull requests and issues, like managing assignees, labels, and milestones, are handled by the REST API to manage issues. To perform these actions on pull requests, you must use the issues API endpoints (for example, /repos/{owner}/{repo}/issues/{issue_number}), not the pull requests endpoints.