SOLFIND
Web Lens
Portal home

About the GraphQL API - GitHub Docs

https://docs.github.com/en/graphql/overview/about-the-graphql-api • 125 KB fetched
Open original page


About the GraphQL API - GitHub Docs Skip to main content GitHub Docs Version: Free, Pro, & Team Search or ask Copilot Search or ask Copilot Select language: current language is English Search or ask Copilot Search or ask Copilot Open menu Collapse sidebar Expand sidebar Scroll breadcrumbs left * Home * GraphQL API * Overview * About the GraphQL API Scroll breadcrumbs right GraphQL API * * * Overview * About the GraphQL API * Public schema * Breaking changes * Changelog * 2026 * 2025 * 2024 * 2023 * 2022 * 2021 * 2020 * 2019 * 2018 * 2017 * Rate and query limits * Reference * Actions * Activity * GitHub Apps * Branches * Checks * Commits * Copilot * Dependabot * Dependency graph * Deploy keys * Deployments * Discussions * Enterprise administration * Gists * Git * Issues * Licenses * Meta * Migrations * Organizations * Packages * Projects * Projects (classic) * Pull requests * Reactions * Releases * Repositories * Search * Security advisories * Sponsors * Teams * Users * Other * Guides * Introduction to GraphQL * Form calls with GraphQL * Using global node IDs * Migrate from REST to GraphQL * Using GraphQL Clients * Pagination * Use GraphQL for Discussions * Migrating global node IDs About the GraphQL API The GitHub GraphQL API offers flexibility and the ability to define precisely the data you want to fetch. Copy as Markdown In this article * Overview * About GraphQL * Why GitHub is using GraphQL * About the GraphQL schema reference * Requesting support 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 GitHub's APIs, see Comparing GitHub's REST API and GraphQL API . 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 GitHub 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 For questions, bug reports, and discussions about GitHub Apps, OAuth apps, and API development, explore the API and Webhooks category in GitHub's Community Discussions . The discussions are moderated and maintained by GitHub staff, and answered by the GitHub community. Consider reaching out to GitHub Support directly using the contact form for: * Guaranteed response from GitHub staff * Support requests involving sensitive data or private concerns * Feature requests * Feedback about GitHub products If you observe unexpected failures, you can use githubstatus.com or the GitHub status API to check for incidents affecting the API. Help and support Did you find what you needed? Yes No Privacy policy Help us make these docs great! All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request. Make a contribution Learn how to contribute Still need help? Ask the GitHub community Contact support Legal * © 2026 GitHub, Inc. * Terms * Privacy * Status * Pricing * Expert services * Blog

Links found on this page

  1. Skip to main content [direct]
  2. GitHub Docs [direct]
  3. GraphQL API [direct]
  4. Overview [direct]
  5. Public schema [direct]
  6. Breaking changes [direct]
  7. 2026 [direct]
  8. 2025 [direct]
  9. 2024 [direct]
  10. 2023 [direct]
  11. 2022 [direct]
  12. 2021 [direct]
  13. 2020 [direct]
  14. 2019 [direct]
  15. 2018 [direct]
  16. 2017 [direct]
  17. Rate and query limits [direct]
  18. Actions [direct]
  19. Activity [direct]
  20. GitHub Apps [direct]
  21. Branches [direct]
  22. Checks [direct]
  23. Commits [direct]
  24. Copilot [direct]
  25. Dependabot [direct]
  26. Dependency graph [direct]
  27. Deploy keys [direct]
  28. Deployments [direct]
  29. Discussions [direct]
  30. Enterprise administration [direct]
  31. Gists [direct]
  32. Git [direct]
  33. Issues [direct]
  34. Licenses [direct]
  35. Meta [direct]
  36. Migrations [direct]
  37. Organizations [direct]
  38. Packages [direct]
  39. Projects [direct]
  40. Projects (classic) [direct]
  41. Pull requests [direct]
  42. Reactions [direct]
  43. Releases [direct]
  44. Repositories [direct]
  45. Search [direct]
  46. Security advisories [direct]
  47. Sponsors [direct]
  48. Teams [direct]
  49. Users [direct]
  50. Other [direct]
  51. Introduction to GraphQL [direct]
  52. Form calls with GraphQL [direct]
  53. Using global node IDs [direct]
  54. Migrate from REST to GraphQL [direct]
  55. Using GraphQL Clients [direct]
  56. Pagination [direct]
  57. Use GraphQL for Discussions [direct]
  58. Migrating global node IDs [direct]
  59. Comparing GitHub's REST API and GraphQL API [direct]
  60. GraphQL [direct]
  61. specification [direct]
  62. announcement blog post [direct]
  63. guides [direct]
  64. API and Webhooks category in GitHub's Community Discussions [direct]
  65. GitHub Support [direct]
  66. githubstatus.com [direct]
  67. GitHub status API [direct]
  68. Privacy policy [direct]
  69. Make a contribution [direct]
  70. Learn how to contribute [direct]
  71. Ask the GitHub community [direct]
  72. Terms [direct]
  73. Pricing [direct]
  74. Expert services [direct]
  75. Blog [direct]