GitHub GraphQL API documentation

To create integrations, retrieve data, and automate your workflows, use the GitHub GraphQL API. The GitHub GraphQL API offers more precise and flexible queries than the GitHub REST API.

Recommended

• About the GraphQL API

  The GitHub GraphQL API offers flexibility and the ability to define precisely the data you want to fetch.

• Introduction to GraphQL

  Learn useful terminology and concepts for using the GitHub GraphQL API.

• Forming calls with GraphQL

  Learn how to authenticate to the GraphQL API, then learn how to create and run queries and mutations.

• Using pagination in the GraphQL API

  Learn how to traverse data sets using cursor based pagination with the GraphQL API.

• Migrating from REST to GraphQL

  Learn best practices and considerations for migrating from GitHub's REST API to GitHub's GraphQL API.

• Rate limits and query limits for the GraphQL API

  The GitHub GraphQL API has limitations in place to protect against excessive or abusive calls to GitHub's servers.

Links

Getting started

• About the GraphQL API

  The GitHub GraphQL API offers flexibility and the ability to define precisely the data you want to fetch.

• Forming calls with GraphQL

  Learn how to authenticate to the GraphQL API, then learn how to create and run queries and mutations.

Articles

• About the GraphQL API

  The GitHub GraphQL API offers flexibility and the ability to define precisely the data you want to fetch.

• Public schema

  Download the public schema for the GitHub GraphQL API.

• Breaking changes

  Learn about recent and upcoming breaking changes to the GitHub GraphQL API.

• GraphQL changelog for 2026

  GraphQL schema changes from 2026.

• GraphQL changelog for 2025

  GraphQL schema changes from 2025.

• GraphQL changelog for 2024

  GraphQL schema changes from 2024.

• GraphQL changelog for 2023

  GraphQL schema changes from 2023.

• GraphQL changelog for 2022

  GraphQL schema changes from 2022.

• GraphQL changelog for 2021

  GraphQL schema changes from 2021.

• GraphQL changelog for 2020

  GraphQL schema changes from 2020.

• GraphQL changelog for 2019

  GraphQL schema changes from 2019.

• GraphQL changelog for 2018

  GraphQL schema changes from 2018.

• GraphQL changelog for 2017

  GraphQL schema changes from 2017.

• Rate limits and query limits for the GraphQL API

  The GitHub GraphQL API has limitations in place to protect against excessive or abusive calls to GitHub's servers.

• Actions

  Reference documentation for GraphQL schema types in the Actions category.

• Activity

  Reference documentation for GraphQL schema types in the Activity category.

• GitHub Apps

  Reference documentation for GraphQL schema types in the GitHub Apps category.

• Branches

  Reference documentation for GraphQL schema types in the Branches category.

• Checks

  Reference documentation for GraphQL schema types in the Checks category.

• Code scanning

  Reference documentation for GraphQL schema types in the Code scanning category.

• Commits

  Reference documentation for GraphQL schema types in the Commits category.

• Copilot

  Reference documentation for GraphQL schema types in the Copilot category.

• Dependabot

  Reference documentation for GraphQL schema types in the Dependabot category.

• Dependency graph

  Reference documentation for GraphQL schema types in the Dependency graph category.

• Deploy keys

  Reference documentation for GraphQL schema types in the Deploy keys category.

• Deployments

  Reference documentation for GraphQL schema types in the Deployments category.

• Discussions

  Reference documentation for GraphQL schema types in the Discussions category.

• Enterprise administration

  Reference documentation for GraphQL schema types in the Enterprise administration category.

• Gists

  Reference documentation for GraphQL schema types in the Gists category.

• Git

  Reference documentation for GraphQL schema types in the Git category.

• Issues

  Reference documentation for GraphQL schema types in the Issues category.

• Licenses

  Reference documentation for GraphQL schema types in the Licenses category.

• Meta

  Reference documentation for GraphQL schema types in the Meta category.

• Migrations

  Reference documentation for GraphQL schema types in the Migrations category.

• Organizations

  Reference documentation for GraphQL schema types in the Organizations category.

• Other

  Reference documentation for GraphQL schema types in the Other category.

• Packages

  Reference documentation for GraphQL schema types in the Packages category.

• Projects

  Reference documentation for GraphQL schema types in the Projects category.

• Projects (classic)

  Reference documentation for GraphQL schema types in the Projects (classic) category.

• Pull requests

  Reference documentation for GraphQL schema types in the Pull requests category.

• Reactions

  Reference documentation for GraphQL schema types in the Reactions category.

• Releases

  Reference documentation for GraphQL schema types in the Releases category.

• Repositories

  Reference documentation for GraphQL schema types in the Repositories category.

• Search

  Reference documentation for GraphQL schema types in the Search category.

• Security advisories

  Reference documentation for GraphQL schema types in the Security advisories category.

• Sponsors

  Reference documentation for GraphQL schema types in the Sponsors category.

• Teams

  Reference documentation for GraphQL schema types in the Teams category.

• Users

  Reference documentation for GraphQL schema types in the Users category.

• Introduction to GraphQL

  Learn useful terminology and concepts for using the GitHub GraphQL API.

• Forming calls with GraphQL

  Learn how to authenticate to the GraphQL API, then learn how to create and run queries and mutations.

• Using global node IDs

  You can get global node IDs of objects via the REST API and use them in GraphQL operations.

• Migrating from REST to GraphQL

  Learn best practices and considerations for migrating from GitHub's REST API to GitHub's GraphQL API.

• Using GraphQL Clients

  You can run queries on real GitHub data using various GraphQL clients and libraries.

• Using pagination in the GraphQL API

  Learn how to traverse data sets using cursor based pagination with the GraphQL API.

• Using the GraphQL API for Discussions

  Learn how to use the GitHub Discussions GraphQL API.

• Migrating GraphQL global node IDs

  Learn about the two global node ID formats and how to migrate from the legacy format to the new format.