Guides

Learn about getting started with GraphQL, migrating from REST to GraphQL, and how to use the GitHub GraphQL API for a variety of tasks.

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 the Explorer

You can run queries on real GitHub data using the GraphQL Explorer, an integrated development environment in your browser that includes docs, syntax highlighting, and validation errors.

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.