docs/content/graphql/overview/about-the-graphql-api.md at main · github/docs · GitHub Skip to content Navigation Menu Sign in Appearance settings * Platform * AI CODE CREATION * GitHub Copilot Write better code with AI * GitHub Copilot app Direct agents from issue to merge * MCP Registry Integrate external tools * DEVELOPER WORKFLOWS * Actions Automate any workflow * Codespaces Instant dev environments * Issues Plan and track work * Code Review Manage code changes * Code Quality Enforce quality at merge * APPLICATION SECURITY * GitHub Advanced Security Find and fix vulnerabilities * Code security Secure your code as you build * Secret protection Stop leaks before they start * EXPLORE * Why GitHub * Documentation * Blog * Changelog * Marketplace View all features * Solutions * BY COMPANY SIZE * Enterprises * Small and medium teams * Startups * Nonprofits * BY USE CASE * App Modernization * DevSecOps * DevOps * CI/CD * View all use cases * BY INDUSTRY * Healthcare * Financial services * Manufacturing * Government * View all industries View all solutions * Resources * EXPLORE BY TOPIC * AI * Software Development * DevOps * Security * View all topics * EXPLORE BY TYPE * Customer stories * Events & webinars * Ebooks & reports * Business insights * GitHub Skills * SUPPORT & SERVICES * Documentation * Customer support * Community forum * Trust center * Partners View all resources * Open Source * COMMUNITY * GitHub Sponsors Fund open source developers * PROGRAMS * Security Lab * Maintainer Community * GitHub Stars * Archive Program * REPOSITORIES * Topics * Trending * Collections * Enterprise * ENTERPRISE SOLUTIONS * Enterprise platform AI-powered developer platform * AVAILABLE ADD-ONS * GitHub Advanced Security Enterprise-grade security features * Copilot for Business Enterprise-grade AI features * Premium Support Enterprise-grade 24/7 support * Pricing Search / Sign in Sign up Appearance settings You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert Uh oh! There was an error while loading. Please reload this page . github / docs Public * Notifications You must be signed in to change notification settings * Fork 68.7k * Star 20.8k * Code * Issues 32 * Pull requests 19 * Actions * Projects * Security and quality 0 * Insights Additional navigation options * Code * Issues * Pull requests * Actions * Projects * Security and quality * Insights Files Expand file tree main Breadcrumbs * docs * / content * / graphql * / overview / about-the-graphql-api.md Copy path Blame More file actions Blame More file actions Latest commit   History History History 58 lines (36 loc) · 3.62 KB main Breadcrumbs * docs * / content * / graphql * / overview / about-the-graphql-api.md Copy path Top File metadata and controls * Preview * Code * Blame 58 lines (36 loc) · 3.62 KB Raw Copy raw file Download raw file Outline Edit and raw actions title About the GraphQL API intro The {% data variables.product.prodname_dotcom %} GraphQL API offers flexibility and the ability to define precisely the data you want to fetch. versions fpt ghec ghes * * * category Get started and make API calls Overview Here are some quick links to get you up and running with the GraphQL API: * Authentication * Root endpoint * Schema introspection * Rate limits * Migrating from REST For more information about {% data variables.product.company_short %}'s APIs, see AUTOTITLE . About GraphQL The GraphQL data query language is: * A specification . The spec determines the validity of the schema on the API server. The schema determines the validity of client calls. * Strongly typed . The schema defines an API's type system and all object relationships. * Introspective . A client can query the schema for details about the schema. * Hierarchical . The shape of a GraphQL call mirrors the shape of the JSON data it returns. Nested fields let you query for and receive only the data you specify in a single round trip. * An application layer. GraphQL is not a storage model or a database query language. The graph refers to graph structures defined in the schema, where nodes define objects and edges define relationships between objects. The API traverses and returns application data based on the schema definitions, independent of how the data is stored. Why GitHub is using GraphQL GitHub chose GraphQL because it offers significantly more flexibility for our integrators. The ability to define precisely the data you want—and only the data you want—is a powerful advantage over traditional REST API endpoints. GraphQL lets you replace multiple REST requests with a single call to fetch the data you specify. For more details about why GitHub invested in GraphQL, see the original announcement blog post . About the GraphQL schema reference The docs in the sidebar are generated from the {% data variables.product.prodname_dotcom %} GraphQL schema . All calls are validated and executed against the schema. Use these docs to find out what data you can call: * Allowed operations: queries and mutations. * Schema-defined types: scalars, objects, enums, interfaces, unions, and input objects. For other information, such as authentication and rate limit details, check out the guides . Requesting support {% data reusables.support.help_resources %} If you observe unexpected failures, you can use githubstatus.com or the {% data variables.product.company_short %} status API to check for incidents affecting the API. Footer (c) 2026 GitHub, Inc. Footer navigation * Terms * Privacy * Security * Status * Community * Docs * Contact * Manage cookies * Do not share my personal information You can’t perform that action at this time.