CINXE.COM

<!DOCTYPE html><html lang="en"><head><script type="text/javascript" src="https://web-static.archive.org/_static/js/bundle-playback.js?v=7YQSqjSh" charset="utf-8"></script> <script type="text/javascript" src="https://web-static.archive.org/_static/js/wombat.js?v=txqj7nKC" charset="utf-8"></script> <script>window.RufflePlayer=window.RufflePlayer||{};window.RufflePlayer.config={"autoplay":"on","unmuteOverlay":"hidden"};</script> <script type="text/javascript" src="https://web-static.archive.org/_static/js/ruffle/ruffle.js"></script> <script type="text/javascript"> __wm.init("https://web.archive.org/web"); __wm.wombat("https://docs.github.com/en/graphql","20211102195623","https://web.archive.org/","web","https://web-static.archive.org/_static/", "1635882983"); </script> <link rel="stylesheet" type="text/css" href="https://web-static.archive.org/_static/css/banner-styles.css?v=p7PEIJWi" /> <link rel="stylesheet" type="text/css" href="https://web-static.archive.org/_static/css/iconochive.css?v=3PDvdIFv" />  <meta charset="utf-8"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="alternate icon" type="image/png" href="/assets/images/site/favicon.png"/><link rel="icon" type="image/svg+xml" href="/web/20211102195623im_/https://docs.github.com/assets/images/site/favicon.svg"/><meta name="google-site-verification" content="c1kuD-K2HIVF635lypcsWPoD4kilo5-jA_wBFyT4uMY"/><meta name="csrf-token" content="oQiSI7Eg-kqoKSlKl0PypznadlCnUwBqsLvw"/><title>GitHub GraphQL API - GitHub Docs</title><meta name="description" content="You can use the GitHub GraphQL API to create precise and flexible queries for the data you need to integrate with GitHub."/><link rel="alternate" hreflang="en" href="https://web.archive.org/web/20211102195623/https://docs.github.com/en/graphql"/><link rel="alternate" hreflang="zh-Hans" href="https://web.archive.org/web/20211102195623/https://docs.github.com/cn/graphql"/><link rel="alternate" hreflang="ja" href="https://web.archive.org/web/20211102195623/https://docs.github.com/ja/graphql"/><link rel="alternate" hreflang="es" href="https://web.archive.org/web/20211102195623/https://docs.github.com/es/graphql"/><link rel="alternate" hreflang="pt" href="https://web.archive.org/web/20211102195623/https://docs.github.com/pt/graphql"/><meta name="path-language" content="en"/><meta name="path-version" content="free-pro-team@latest"/><meta name="path-product" content="graphql"/><meta name="path-article" content="graphql"/><meta name="page-document-type" content="product"/><meta name="status" content="200"/><meta property="og:site_name" content="GitHub Docs"/><meta property="og:title" content="GitHub GraphQL API - GitHub Docs"/><meta property="og:type" content="article"/><meta property="og:url" content="https://web.archive.org/web/20211102195623/https://docs.github.com/en/graphql"/><meta property="og:image" content="https://web.archive.org/web/20211102195623im_/https://github.githubassets.com/images/modules/open_graph/github-logo.png"/><meta name="next-head-count" content="24"/><link rel="preload" href="/web/20211102195623/https://docs.github.com/_next/static/css/7fbe7a284d6b60d85557.css" as="style"/><link rel="stylesheet" href="/web/20211102195623cs_/https://docs.github.com/_next/static/css/7fbe7a284d6b60d85557.css" data-n-g=""/><link rel="preload" href="/web/20211102195623/https://docs.github.com/_next/static/css/f4b3e8ddb97e33443db9.css" as="style"/><link rel="stylesheet" href="/web/20211102195623cs_/https://docs.github.com/_next/static/css/f4b3e8ddb97e33443db9.css" data-n-p=""/><noscript data-n-css=""></noscript><script defer="" nomodule="" src="/web/20211102195623js_/https://docs.github.com/_next/static/chunks/polyfills-a40ef1678bae11e696dba45124eadd70.js"></script><script src="/web/20211102195623js_/https://docs.github.com/_next/static/chunks/webpack-af28476a2e7790fd48db.js" defer=""></script><script src="/web/20211102195623js_/https://docs.github.com/_next/static/chunks/framework-2b8be631586cbbc6886e.js" defer=""></script><script src="/web/20211102195623js_/https://docs.github.com/_next/static/chunks/main-c689edff8b5bb05415ad.js" defer=""></script><script src="/web/20211102195623js_/https://docs.github.com/_next/static/chunks/pages/_app-4cf9c12c30eb92208569.js" defer=""></script><script src="/web/20211102195623js_/https://docs.github.com/_next/static/chunks/0e226fb0-714f575af96cabb85aeb.js" defer=""></script><script src="/web/20211102195623js_/https://docs.github.com/_next/static/chunks/780-f33d983279a3b510b59a.js" defer=""></script><script src="/web/20211102195623js_/https://docs.github.com/_next/static/chunks/729-74bb5ca202eb8230e4e7.js" defer=""></script><script src="/web/20211102195623js_/https://docs.github.com/_next/static/chunks/521-21427a7650f6a316ebd9.js" defer=""></script><script src="/web/20211102195623js_/https://docs.github.com/_next/static/chunks/786-ce6758eb4d4187a0ce23.js" defer=""></script><script src="/web/20211102195623js_/https://docs.github.com/_next/static/chunks/pages/%5BversionId%5D/%5BproductId%5D-45be648cb3b3b9a245c3.js" defer=""></script><script src="/web/20211102195623js_/https://docs.github.com/_next/static/JLUjmF_ihwlS7y-ufQZEU/_buildManifest.js" defer=""></script><script src="/web/20211102195623js_/https://docs.github.com/_next/static/JLUjmF_ihwlS7y-ufQZEU/_ssgManifest.js" defer=""></script><style data-styled="" data-styled-version="5.3.3">.kjefjn{padding-top:8px;padding-bottom:8px;}/*!sc*/ .PSGvS{margin-top:4px;}/*!sc*/ .imrYun{grid-area:topper-sidebar;}/*!sc*/ .gTUBqP{margin-top:8px;padding-top:8px;padding-bottom:4px;border-color:#d0d7de;border-top-width:1px;border-top-style:solid;}/*!sc*/ .kQOfLl{grid-area:content;}/*!sc*/ data-styled.g3[id="Box-nv15kw-0"]{content:"kjefjn,PSGvS,imrYun,gTUBqP,kQOfLl,"}/*!sc*/ .brfqyl > summary{list-style:none;}/*!sc*/ .brfqyl > summary::-webkit-details-marker{display:none;}/*!sc*/ data-styled.g58[id="Details-ssy9qz-0"]{content:"brfqyl,"}/*!sc*/ .sJQgk{border:4px solid transparent;margin-left:12px;border-top-color:currentcolor;border-bottom-width:0;content:'';display:inline-block;height:0;vertical-align:middle;width:0;}/*!sc*/ data-styled.g64[id="Dropdown__DropdownCaret-sc-16yoecj-1"]{content:"sJQgk,"}/*!sc*/ .hEUCoC{background-clip:padding-box;background-color:#ffffff;border:1px solid #d0d7de;border-radius:6px;box-shadow:0 8px 24px rgba(140,149,159,0.2);left:0;list-style:none;margin-top:2px;padding:5px 0 5px 0 !important;position:absolute;top:100%;width:160px;z-index:100;right:0;left:auto;}/*!sc*/ .hEUCoC::before{position:absolute;display:inline-block;content:'';}/*!sc*/ .hEUCoC::after{position:absolute;display:inline-block;content:'';}/*!sc*/ .hEUCoC::before{border:8px solid transparent;border-bottom-color:#ffffff;}/*!sc*/ .hEUCoC::after{border:7px solid transparent;border-bottom-color:#ffffff;}/*!sc*/ .hEUCoC > ul{list-style:none;}/*!sc*/ .hEUCoC::before{top:-16px;right:9px;left:auto;}/*!sc*/ .hEUCoC::after{top:-14px;right:10px;left:auto;}/*!sc*/ data-styled.g65[id="Dropdown__DropdownMenu-sc-16yoecj-2"]{content:"hEUCoC,"}/*!sc*/ .knVSGE{display:block;padding:4px 10px 4px 15px;overflow:hidden;color:#24292f;text-overflow:ellipsis;white-space:nowrap;}/*!sc*/ .knVSGE a{color:#24292f;-webkit-text-decoration:none;text-decoration:none;display:block;overflow:hidden;color:#24292f;text-overflow:ellipsis;white-space:nowrap;}/*!sc*/ .knVSGE:focus,.knVSGE a:focus{color:#ffffff;-webkit-text-decoration:none;text-decoration:none;background-color:#0969da;}/*!sc*/ .knVSGE:hover,.knVSGE:hover a{color:#ffffff;-webkit-text-decoration:none;text-decoration:none;background-color:#0969da;outline:none;}/*!sc*/ data-styled.g66[id="Dropdown__DropdownItem-sc-16yoecj-3"]{content:"knVSGE,"}/*!sc*/ .hdGJqD{font-weight:600;font-size:32px;margin:0;font-size:14px;}/*!sc*/ data-styled.g76[id="Heading-sc-1cjoo9h-0"]{content:"hdGJqD,"}/*!sc*/ .hgUhMY{max-width:720px;display:grid;grid-template-columns:minmax(0,1fr);grid-template-areas:'topper' 'topper-sidebar' 'intro' 'sidebar' 'content';row-gap:8px;}/*!sc*/ @media (min-width:1280px){.hgUhMY{max-width:none;padding-top:24px;grid-template-rows:auto 1fr;grid-template-columns:minmax(500px,720px) minmax(220px,1fr);grid-template-areas:'topper topper-sidebar' 'intro sidebar' 'content sidebar';-webkit-column-gap:80px;column-gap:80px;row-gap:0;}}/*!sc*/ data-styled.g123[id="ArticleGridLayout__Container-sc-we7dhr-0"]{content:"hgUhMY,"}/*!sc*/ </style></head><body data-color-mode="auto" data-dark-theme="dark" data-light-theme="light"><div id="__next"><div class="d-lg-flex"><div class="d-none d-lg-block bg-primary position-sticky top-0 overflow-y-auto flex-shrink-0 pb-5 border-right" style="width:326px;height:100vh"><div class="d-flex flex-items-center p-4 position-sticky top-0 color-bg-default" style="z-index:3" id="github-logo" role="banner"><a rel="" class="color-fg-default" aria-hidden="true" tabindex="-1" href="/web/20211102195623/https://docs.github.com/en"><svg aria-hidden="true" role="img" class="octicon octicon-mark-github" viewbox="0 0 16 16" width="32" height="32" fill="currentColor" style="display:inline-block;user-select:none;vertical-align:text-bottom;overflow:visible"><path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0016 8c0-4.42-3.58-8-8-8z"></path></svg></a><a rel="" class="f4 text-semibold color-fg-default no-underline no-wrap pl-2 flex-auto" href="/web/20211102195623/https://docs.github.com/en">GitHub Docs</a></div><nav><ul data-testid="sidebar"><li title="Home"><a href="/web/20211102195623/https://docs.github.com/en" class="f6 pl-4 pr-5 ml-n1 pb-1 color-fg-default"><svg aria-hidden="true" role="img" class="mr-1" viewbox="0 0 16 16" width="16" height="16" fill="currentColor" style="display:inline-block;user-select:none;vertical-align:text-bottom;overflow:visible"><path fill-rule="evenodd" d="M7.78 12.53a.75.75 0 01-1.06 0L2.47 8.28a.75.75 0 010-1.06l4.25-4.25a.75.75 0 011.06 1.06L4.81 7h7.44a.75.75 0 010 1.5H4.81l2.97 2.97a.75.75 0 010 1.06z"></path></svg>All products</a></li><li data-testid="sidebar-product" title="GraphQL API" class="my-2"><a rel="" class="pl-4 pr-5 pb-1 f4 color-fg-default no-underline" href="/web/20211102195623/https://docs.github.com/en/graphql">GraphQL API</a></li><li class="my-3"><ul class="list-style-none"><li data-is-active-category="false" data-is-current-page="false" class="py-1"><details class="details-reset"><summary class="outline-none"><div class="d-flex flex-justify-between"><div class="pl-4 pr-1 py-2 f6 text-uppercase d-block flex-auto mr-3 color-fg-default no-underline text-bold">Overview</div><span style="margin-top:7px" class="flex-shrink-0 pr-3"><svg aria-hidden="true" role="img" class="opacity-60" viewbox="0 0 16 16" width="16" height="16" fill="currentColor" style="display:inline-block;user-select:none;vertical-align:text-bottom;overflow:visible"><path fill-rule="evenodd" d="M12.78 6.22a.75.75 0 010 1.06l-4.25 4.25a.75.75 0 01-1.06 0L3.22 7.28a.75.75 0 011.06-1.06L8 9.94l3.72-3.72a.75.75 0 011.06 0z"></path></svg></span></div></summary><ul data-testid="sidebar-article-group" class="list-style-none pb-2"><li data-testid="sidebar-article" data-is-current-page="false" class="position-relative SidebarProduct_sidebarArticle____jm-"><a rel="" class="d-block pl-6 pr-5 py-1 no-underline color-fg-default" href="/web/20211102195623/https://docs.github.com/en/graphql/overview/about-the-graphql-api">About the GraphQL API</a></li><li data-testid="sidebar-article" data-is-current-page="false" class="position-relative SidebarProduct_sidebarArticle____jm-"><a rel="" class="d-block pl-6 pr-5 py-1 no-underline color-fg-default" href="/web/20211102195623/https://docs.github.com/en/graphql/overview/public-schema">Public schema</a></li><li data-testid="sidebar-article" data-is-current-page="false" class="position-relative SidebarProduct_sidebarArticle____jm-"><a rel="" class="d-block pl-6 pr-5 py-1 no-underline color-fg-default" href="/web/20211102195623/https://docs.github.com/en/graphql/overview/schema-previews">Schema previews</a></li><li data-testid="sidebar-article" data-is-current-page="false" class="position-relative SidebarProduct_sidebarArticle____jm-"><a rel="" class="d-block pl-6 pr-5 py-1 no-underline color-fg-default" href="/web/20211102195623/https://docs.github.com/en/graphql/overview/breaking-changes">Breaking changes</a></li><li data-testid="sidebar-article" data-is-current-page="false" class="position-relative SidebarProduct_sidebarArticle____jm-"><a rel="" class="d-block pl-6 pr-5 py-1 no-underline color-fg-default" href="/web/20211102195623/https://docs.github.com/en/graphql/overview/changelog">Changelog</a></li><li data-testid="sidebar-article" data-is-current-page="false" class="position-relative SidebarProduct_sidebarArticle____jm-"><a rel="" class="d-block pl-6 pr-5 py-1 no-underline color-fg-default" href="/web/20211102195623/https://docs.github.com/en/graphql/overview/explorer">Explorer</a></li><li data-testid="sidebar-article" data-is-current-page="false" class="position-relative SidebarProduct_sidebarArticle____jm-"><a rel="" class="d-block pl-6 pr-5 py-1 no-underline color-fg-default" href="/web/20211102195623/https://docs.github.com/en/graphql/overview/resource-limitations">Resource limitations</a></li></ul></details></li><li data-is-active-category="false" data-is-current-page="false" class="py-1"><details class="details-reset"><summary class="outline-none"><div class="d-flex flex-justify-between"><div class="pl-4 pr-1 py-2 f6 text-uppercase d-block flex-auto mr-3 color-fg-default no-underline text-bold">Reference</div><span style="margin-top:7px" class="flex-shrink-0 pr-3"><svg aria-hidden="true" role="img" class="opacity-60" viewbox="0 0 16 16" width="16" height="16" fill="currentColor" style="display:inline-block;user-select:none;vertical-align:text-bottom;overflow:visible"><path fill-rule="evenodd" d="M12.78 6.22a.75.75 0 010 1.06l-4.25 4.25a.75.75 0 01-1.06 0L3.22 7.28a.75.75 0 011.06-1.06L8 9.94l3.72-3.72a.75.75 0 011.06 0z"></path></svg></span></div></summary><ul data-testid="sidebar-article-group" class="list-style-none pb-2"><li data-testid="sidebar-article" data-is-current-page="false" class="position-relative SidebarProduct_sidebarArticle____jm-"><a rel="" class="d-block pl-6 pr-5 py-1 no-underline color-fg-default" href="/web/20211102195623/https://docs.github.com/en/graphql/reference/queries">Queries</a></li><li data-testid="sidebar-article" data-is-current-page="false" class="position-relative SidebarProduct_sidebarArticle____jm-"><a rel="" class="d-block pl-6 pr-5 py-1 no-underline color-fg-default" href="/web/20211102195623/https://docs.github.com/en/graphql/reference/mutations">Mutations</a></li><li data-testid="sidebar-article" data-is-current-page="false" class="position-relative SidebarProduct_sidebarArticle____jm-"><a rel="" class="d-block pl-6 pr-5 py-1 no-underline color-fg-default" href="/web/20211102195623/https://docs.github.com/en/graphql/reference/objects">Objects</a></li><li data-testid="sidebar-article" data-is-current-page="false" class="position-relative SidebarProduct_sidebarArticle____jm-"><a rel="" class="d-block pl-6 pr-5 py-1 no-underline color-fg-default" href="/web/20211102195623/https://docs.github.com/en/graphql/reference/interfaces">Interfaces</a></li><li data-testid="sidebar-article" data-is-current-page="false" class="position-relative SidebarProduct_sidebarArticle____jm-"><a rel="" class="d-block pl-6 pr-5 py-1 no-underline color-fg-default" href="/web/20211102195623/https://docs.github.com/en/graphql/reference/enums">Enums</a></li><li data-testid="sidebar-article" data-is-current-page="false" class="position-relative SidebarProduct_sidebarArticle____jm-"><a rel="" class="d-block pl-6 pr-5 py-1 no-underline color-fg-default" href="/web/20211102195623/https://docs.github.com/en/graphql/reference/unions">Unions</a></li><li data-testid="sidebar-article" data-is-current-page="false" class="position-relative SidebarProduct_sidebarArticle____jm-"><a rel="" class="d-block pl-6 pr-5 py-1 no-underline color-fg-default" href="/web/20211102195623/https://docs.github.com/en/graphql/reference/input-objects">Input objects</a></li><li data-testid="sidebar-article" data-is-current-page="false" class="position-relative SidebarProduct_sidebarArticle____jm-"><a rel="" class="d-block pl-6 pr-5 py-1 no-underline color-fg-default" href="/web/20211102195623/https://docs.github.com/en/graphql/reference/scalars">Scalars</a></li></ul></details></li><li data-is-active-category="false" data-is-current-page="false" class="py-1"><details class="details-reset"><summary class="outline-none"><div class="d-flex flex-justify-between"><div class="pl-4 pr-1 py-2 f6 text-uppercase d-block flex-auto mr-3 color-fg-default no-underline text-bold">Guides</div><span style="margin-top:7px" class="flex-shrink-0 pr-3"><svg aria-hidden="true" role="img" class="opacity-60" viewbox="0 0 16 16" width="16" height="16" fill="currentColor" style="display:inline-block;user-select:none;vertical-align:text-bottom;overflow:visible"><path fill-rule="evenodd" d="M12.78 6.22a.75.75 0 010 1.06l-4.25 4.25a.75.75 0 01-1.06 0L3.22 7.28a.75.75 0 011.06-1.06L8 9.94l3.72-3.72a.75.75 0 011.06 0z"></path></svg></span></div></summary><ul data-testid="sidebar-article-group" class="list-style-none pb-2"><li data-testid="sidebar-article" data-is-current-page="false" class="position-relative SidebarProduct_sidebarArticle____jm-"><a rel="" class="d-block pl-6 pr-5 py-1 no-underline color-fg-default" href="/web/20211102195623/https://docs.github.com/en/graphql/guides/introduction-to-graphql">Introduction to GraphQL</a></li><li data-testid="sidebar-article" data-is-current-page="false" class="position-relative SidebarProduct_sidebarArticle____jm-"><a rel="" class="d-block pl-6 pr-5 py-1 no-underline color-fg-default" href="/web/20211102195623/https://docs.github.com/en/graphql/guides/forming-calls-with-graphql">Form calls with GraphQL</a></li><li data-testid="sidebar-article" data-is-current-page="false" class="position-relative SidebarProduct_sidebarArticle____jm-"><a rel="" class="d-block pl-6 pr-5 py-1 no-underline color-fg-default" href="/web/20211102195623/https://docs.github.com/en/graphql/guides/using-global-node-ids">Using global node IDs</a></li><li data-testid="sidebar-article" data-is-current-page="false" class="position-relative SidebarProduct_sidebarArticle____jm-"><a rel="" class="d-block pl-6 pr-5 py-1 no-underline color-fg-default" href="/web/20211102195623/https://docs.github.com/en/graphql/guides/migrating-from-rest-to-graphql">Migrate from REST to GraphQL</a></li><li data-testid="sidebar-article" data-is-current-page="false" class="position-relative SidebarProduct_sidebarArticle____jm-"><a rel="" class="d-block pl-6 pr-5 py-1 no-underline color-fg-default" href="/web/20211102195623/https://docs.github.com/en/graphql/guides/using-the-explorer">Using the Explorer</a></li><li data-testid="sidebar-article" data-is-current-page="false" class="position-relative SidebarProduct_sidebarArticle____jm-"><a rel="" class="d-block pl-6 pr-5 py-1 no-underline color-fg-default" href="/web/20211102195623/https://docs.github.com/en/graphql/guides/using-the-graphql-api-for-discussions">Use GraphQL for Discussions</a></li></ul></details></li></ul></li></ul></nav></div><main class="flex-1 min-width-0"><div class="border-bottom d-unset color-border-muted no-print z-3 color-bg-default Header_header__GIthp"><div></div><header class="color-bg-default container-xl px-3 px-md-6 pt-3 pb-3 position-sticky top-0 z-3 color-shadow-small"><div class="d-none d-lg-flex flex-justify-end flex-items-center" data-testid="desktop-header"><div class="mr-auto"><nav data-testid="breadcrumbs" class="f5 breadcrumbs" aria-label="Breadcrumb"><a rel="" data-testid="breadcrumb-link" title="product: GraphQL API" class="d-inline-block px-2 color-fg-muted" href="/web/20211102195623/https://docs.github.com/en/graphql">GraphQL API</a></nav></div><details data-testid="language-picker" class="Details-ssy9qz-0 brfqyl position-relative"><summary class="d-block btn btn-invisible color-fg-default"><span class="Text-sc-1s3uzov-0 cEiopf">English</span><div class="Dropdown__DropdownCaret-sc-16yoecj-1 sJQgk"></div></summary><ul direction="sw" style="width:unset" class="Dropdown__DropdownMenu-sc-16yoecj-2 hEUCoC"><li class="Dropdown__DropdownItem-sc-16yoecj-3 knVSGE"><a rel="" href="/web/20211102195623/https://docs.github.com/en/graphql">English</a></li><li class="Dropdown__DropdownItem-sc-16yoecj-3 knVSGE"><a rel="" href="/web/20211102195623/https://docs.github.com/cn/graphql">简体中文 (Simplified Chinese)</a></li><li class="Dropdown__DropdownItem-sc-16yoecj-3 knVSGE"><a rel="" href="/web/20211102195623/https://docs.github.com/ja/graphql">日本語 (Japanese)</a></li><li class="Dropdown__DropdownItem-sc-16yoecj-3 knVSGE"><a rel="" href="/web/20211102195623/https://docs.github.com/es/graphql">Español (Spanish)</a></li><li class="Dropdown__DropdownItem-sc-16yoecj-3 knVSGE"><a rel="" href="/web/20211102195623/https://docs.github.com/pt/graphql">Português do Brasil (Portuguese)</a></li></ul></details><div class="d-inline-block ml-3"><div data-testid="search" aria-hidden="true"><div class="position-relative z-2"><form role="search" class="width-full d-flex" novalidate=""><input type="search" data-testid="site-search-input" class="Search_searchInput__ydDV7 form-control px-5 f4 py-2 Search_searchInputOverlay__22svo" style="background:var(--color-canvas-default) url("/web/20211102195623im_/https://docs.github.com/assets/images/octicons/search.svg") no-repeat 6px" placeholder="Search topics, products..." autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" maxlength="512" value=""/><button class="d-none" type="submit" title="Submit the search query." hidden=""></button></form></div></div><div id="search-results-container" class="z-1 pb-4 px-3 Search_resultsContainer__3RRWL Search_resultsContainerOverlay__1LwY4"><div class="mt-2 px-6"><span> </span></div></div><div class="-z-1 d-none"></div></div></div><div class="d-lg-none" data-testid="mobile-header"><div class="d-flex flex-justify-between"><div class="d-flex flex-items-center" id="github-logo-mobile" role="banner"><a rel="" aria-hidden="true" tabindex="-1" href="/web/20211102195623/https://docs.github.com/en"><svg aria-hidden="true" role="img" class="color-fg-default" viewbox="0 0 16 16" width="32" height="32" fill="currentColor" style="display:inline-block;user-select:none;vertical-align:text-bottom;overflow:visible"><path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0016 8c0-4.42-3.58-8-8-8z"></path></svg></a><a rel="" class="f4 text-semibold color-fg-default no-underline no-wrap pl-2" href="/web/20211102195623/https://docs.github.com/en">GitHub Docs</a></div><div><button class="btn" data-testid="mobile-menu-button" aria-label="Navigation Menu"><svg aria-hidden="true" role="img" class="octicon octicon-three-bars" viewbox="0 0 16 16" width="16" height="16" fill="currentColor" style="display:inline-block;user-select:none;vertical-align:text-bottom;overflow:visible"><path fill-rule="evenodd" d="M1 2.75A.75.75 0 011.75 2h12.5a.75.75 0 110 1.5H1.75A.75.75 0 011 2.75zm0 5A.75.75 0 011.75 7h12.5a.75.75 0 110 1.5H1.75A.75.75 0 011 7.75zM1.75 12a.75.75 0 100 1.5h12.5a.75.75 0 100-1.5H1.75z"></path></svg></button></div></div><div class="relative"><div class="width-full position-sticky top-0 d-none"><div class="mt-3 mb-2"><div class="pt-3 mb-4 ml-2"><nav data-testid="breadcrumbs" class="f5 breadcrumbs" aria-label="Breadcrumb"><a rel="" data-testid="breadcrumb-link" title="product: GraphQL API" class="d-inline-block px-2 color-fg-muted" href="/web/20211102195623/https://docs.github.com/en/graphql">GraphQL API</a></nav></div><h4 class="f5 text-normal color-fg-muted ml-3">Explore by product</h4><details class="Details-ssy9qz-0 brfqyl details-reset"><summary class="d-block color-fg-default btn btn-invisible" role="button" aria-label="Toggle products list"><div data-testid="current-product" data-current-product-path="/graphql" class="d-flex flex-items-center flex-justify-between"><span>GraphQL API</span><svg aria-hidden="true" role="img" class="arrow ml-md-1" viewbox="0 0 24 24" width="24" height="24" fill="currentColor" style="display:inline-block;user-select:none;vertical-align:text-bottom;overflow:visible"><path fill-rule="evenodd" d="M5.22 8.72a.75.75 0 000 1.06l6.25 6.25a.75.75 0 001.06 0l6.25-6.25a.75.75 0 00-1.06-1.06L12 14.44 6.28 8.72a.75.75 0 00-1.06 0z"></path></svg></div></summary><div data-testid="product-picker-list" style="z-index:6" class="Box-nv15kw-0 kjefjn"><li class="Dropdown__DropdownItem-sc-16yoecj-3 knVSGE"><a rel="" href="/web/20211102195623/https://docs.github.com/en/get-started">Get started</a></li><li class="Dropdown__DropdownItem-sc-16yoecj-3 knVSGE"><a rel="" href="/web/20211102195623/https://docs.github.com/en/account-and-profile">Account and profile</a></li><li class="Dropdown__DropdownItem-sc-16yoecj-3 knVSGE"><a rel="" href="/web/20211102195623/https://docs.github.com/en/authentication">Authentication</a></li><li class="Dropdown__DropdownItem-sc-16yoecj-3 knVSGE"><a rel="" href="/web/20211102195623/https://docs.github.com/en/repositories">Repositories</a></li><li class="Dropdown__DropdownItem-sc-16yoecj-3 knVSGE"><a rel="" href="/web/20211102195623/https://docs.github.com/en/github">GitHub</a></li><li class="Dropdown__DropdownItem-sc-16yoecj-3 knVSGE"><a rel="" href="/web/20211102195623/https://docs.github.com/en/enterprise-cloud@latest/admin">Enterprise administrators</a></li><li class="Dropdown__DropdownItem-sc-16yoecj-3 knVSGE"><a rel="" href="/web/20211102195623/https://docs.github.com/en/billing">Billing and payments</a></li><li class="Dropdown__DropdownItem-sc-16yoecj-3 knVSGE"><a rel="" href="/web/20211102195623/https://docs.github.com/en/organizations">Organizations</a></li><li class="Dropdown__DropdownItem-sc-16yoecj-3 knVSGE"><a rel="" href="/web/20211102195623/https://docs.github.com/en/code-security">Code security</a></li><li class="Dropdown__DropdownItem-sc-16yoecj-3 knVSGE"><a rel="" href="/web/20211102195623/https://docs.github.com/en/pull-requests">Pull requests</a></li><li class="Dropdown__DropdownItem-sc-16yoecj-3 knVSGE"><a rel="" href="/web/20211102195623/https://docs.github.com/en/issues">GitHub Issues</a></li><li class="Dropdown__DropdownItem-sc-16yoecj-3 knVSGE"><a rel="" href="/web/20211102195623/https://docs.github.com/en/actions">GitHub Actions</a></li><li class="Dropdown__DropdownItem-sc-16yoecj-3 knVSGE"><a rel="" href="/web/20211102195623/https://docs.github.com/en/codespaces">GitHub Codespaces</a></li><li class="Dropdown__DropdownItem-sc-16yoecj-3 knVSGE"><a rel="" href="/web/20211102195623/https://docs.github.com/en/packages">GitHub Packages</a></li><li class="Dropdown__DropdownItem-sc-16yoecj-3 knVSGE"><a rel="" href="/web/20211102195623/https://docs.github.com/en/search-github">Search on GitHub</a></li><li class="Dropdown__DropdownItem-sc-16yoecj-3 knVSGE"><a rel="" href="/web/20211102195623/https://docs.github.com/en/developers">Developers</a></li><li class="Dropdown__DropdownItem-sc-16yoecj-3 knVSGE"><a rel="" href="/web/20211102195623/https://docs.github.com/en/rest">REST API</a></li><li class="Dropdown__DropdownItem-sc-16yoecj-3 knVSGE"><a rel="" href="/web/20211102195623/https://docs.github.com/en/graphql">GraphQL API</a></li><li class="Dropdown__DropdownItem-sc-16yoecj-3 knVSGE"><a rel="" href="/web/20211102195623/https://docs.github.com/en/github-cli">GitHub CLI</a></li><li class="Dropdown__DropdownItem-sc-16yoecj-3 knVSGE"><a rel="" href="/web/20211102195623/https://docs.github.com/en/discussions">GitHub Discussions</a></li><li class="Dropdown__DropdownItem-sc-16yoecj-3 knVSGE"><a rel="" href="/web/20211102195623/https://docs.github.com/en/sponsors">GitHub Sponsors</a></li><li class="Dropdown__DropdownItem-sc-16yoecj-3 knVSGE"><a rel="" href="/web/20211102195623/https://docs.github.com/en/communities">Building communities</a></li><li class="Dropdown__DropdownItem-sc-16yoecj-3 knVSGE"><a rel="" href="/web/20211102195623/https://docs.github.com/en/pages">GitHub Pages</a></li><li class="Dropdown__DropdownItem-sc-16yoecj-3 knVSGE"><a rel="" href="/web/20211102195623/https://docs.github.com/en/education">Education</a></li><li class="Dropdown__DropdownItem-sc-16yoecj-3 knVSGE"><a rel="" href="/web/20211102195623/https://docs.github.com/en/desktop">GitHub Desktop</a></li><li class="Dropdown__DropdownItem-sc-16yoecj-3 knVSGE"><a rel="noopener" href="https://web.archive.org/web/20211102195623/https://atom.io/docs">Atom<span class="ml-1"><svg aria-hidden="true" role="img" class="octicon octicon-link-external" viewbox="0 0 16 16" width="16" height="16" fill="currentColor" style="display:inline-block;user-select:none;vertical-align:text-bottom;overflow:visible"><path fill-rule="evenodd" d="M10.604 1h4.146a.25.25 0 01.25.25v4.146a.25.25 0 01-.427.177L13.03 4.03 9.28 7.78a.75.75 0 01-1.06-1.06l3.75-3.75-1.543-1.543A.25.25 0 0110.604 1zM3.75 2A1.75 1.75 0 002 3.75v8.5c0 .966.784 1.75 1.75 1.75h8.5A1.75 1.75 0 0014 12.25v-3.5a.75.75 0 00-1.5 0v3.5a.25.25 0 01-.25.25h-8.5a.25.25 0 01-.25-.25v-8.5a.25.25 0 01.25-.25h3.5a.75.75 0 000-1.5h-3.5z"></path></svg></span></a></li><li class="Dropdown__DropdownItem-sc-16yoecj-3 knVSGE"><a rel="noopener" href="https://web.archive.org/web/20211102195623/https://electronjs.org/docs">Electron<span class="ml-1"><svg aria-hidden="true" role="img" class="octicon octicon-link-external" viewbox="0 0 16 16" width="16" height="16" fill="currentColor" style="display:inline-block;user-select:none;vertical-align:text-bottom;overflow:visible"><path fill-rule="evenodd" d="M10.604 1h4.146a.25.25 0 01.25.25v4.146a.25.25 0 01-.427.177L13.03 4.03 9.28 7.78a.75.75 0 01-1.06-1.06l3.75-3.75-1.543-1.543A.25.25 0 0110.604 1zM3.75 2A1.75 1.75 0 002 3.75v8.5c0 .966.784 1.75 1.75 1.75h8.5A1.75 1.75 0 0014 12.25v-3.5a.75.75 0 00-1.5 0v3.5a.25.25 0 01-.25.25h-8.5a.25.25 0 01-.25-.25v-8.5a.25.25 0 01.25-.25h3.5a.75.75 0 000-1.5h-3.5z"></path></svg></span></a></li><li class="Dropdown__DropdownItem-sc-16yoecj-3 knVSGE"><a rel="noopener" href="https://web.archive.org/web/20211102195623/https://codeql.github.com/docs">CodeQL<span class="ml-1"><svg aria-hidden="true" role="img" class="octicon octicon-link-external" viewbox="0 0 16 16" width="16" height="16" fill="currentColor" style="display:inline-block;user-select:none;vertical-align:text-bottom;overflow:visible"><path fill-rule="evenodd" d="M10.604 1h4.146a.25.25 0 01.25.25v4.146a.25.25 0 01-.427.177L13.03 4.03 9.28 7.78a.75.75 0 01-1.06-1.06l3.75-3.75-1.543-1.543A.25.25 0 0110.604 1zM3.75 2A1.75 1.75 0 002 3.75v8.5c0 .966.784 1.75 1.75 1.75h8.5A1.75 1.75 0 0014 12.25v-3.5a.75.75 0 00-1.5 0v3.5a.25.25 0 01-.25.25h-8.5a.25.25 0 01-.25-.25v-8.5a.25.25 0 01.25-.25h3.5a.75.75 0 000-1.5h-3.5z"></path></svg></span></a></li><li class="Dropdown__DropdownItem-sc-16yoecj-3 knVSGE"><a rel="noopener" href="https://web.archive.org/web/20211102195623/https://docs.npmjs.com/">npm<span class="ml-1"><svg aria-hidden="true" role="img" class="octicon octicon-link-external" viewbox="0 0 16 16" width="16" height="16" fill="currentColor" style="display:inline-block;user-select:none;vertical-align:text-bottom;overflow:visible"><path fill-rule="evenodd" d="M10.604 1h4.146a.25.25 0 01.25.25v4.146a.25.25 0 01-.427.177L13.03 4.03 9.28 7.78a.75.75 0 01-1.06-1.06l3.75-3.75-1.543-1.543A.25.25 0 0110.604 1zM3.75 2A1.75 1.75 0 002 3.75v8.5c0 .966.784 1.75 1.75 1.75h8.5A1.75 1.75 0 0014 12.25v-3.5a.75.75 0 00-1.5 0v3.5a.25.25 0 01-.25.25h-8.5a.25.25 0 01-.25-.25v-8.5a.25.25 0 01.25-.25h3.5a.75.75 0 000-1.5h-3.5z"></path></svg></span></a></li></div></details></div><div class="border-top my-2 mx-3"></div><details data-testid="language-picker" class="Details-ssy9qz-0 brfqyl"><summary class="d-block btn btn-invisible color-fg-default" aria-label="Toggle language list"><div class="d-flex flex-items-center flex-justify-between"><span class="Text-sc-1s3uzov-0 cEiopf">English</span><svg aria-hidden="true" role="img" class="arrow ml-md-1" viewbox="0 0 24 24" width="24" height="24" fill="currentColor" style="display:inline-block;user-select:none;vertical-align:text-bottom;overflow:visible"><path fill-rule="evenodd" d="M5.22 8.72a.75.75 0 000 1.06l6.25 6.25a.75.75 0 001.06 0l6.25-6.25a.75.75 0 00-1.06-1.06L12 14.44 6.28 8.72a.75.75 0 00-1.06 0z"></path></svg></div></summary><div class="Box-nv15kw-0 PSGvS"><li class="Dropdown__DropdownItem-sc-16yoecj-3 knVSGE"><a rel="" href="/web/20211102195623/https://docs.github.com/en/graphql">English</a></li><li class="Dropdown__DropdownItem-sc-16yoecj-3 knVSGE"><a rel="" href="/web/20211102195623/https://docs.github.com/cn/graphql">简体中文 (Simplified Chinese)</a></li><li class="Dropdown__DropdownItem-sc-16yoecj-3 knVSGE"><a rel="" href="/web/20211102195623/https://docs.github.com/ja/graphql">日本語 (Japanese)</a></li><li class="Dropdown__DropdownItem-sc-16yoecj-3 knVSGE"><a rel="" href="/web/20211102195623/https://docs.github.com/es/graphql">Español (Spanish)</a></li><li class="Dropdown__DropdownItem-sc-16yoecj-3 knVSGE"><a rel="" href="/web/20211102195623/https://docs.github.com/pt/graphql">Português do Brasil (Portuguese)</a></li></div></details><div class="my-2 pt-3 mx-3"><div data-testid="search" aria-hidden="true"><div class="position-relative z-2"><form role="search" class="width-full d-flex" novalidate=""><input type="search" data-testid="site-search-input" class="Search_searchInput__ydDV7 form-control px-5 f4 py-2 width-full" style="background:var(--color-canvas-default) url("/web/20211102195623im_/https://docs.github.com/assets/images/octicons/search.svg") no-repeat 6px" placeholder="Search topics, products..." autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" maxlength="512" value=""/><button class="d-none" type="submit" title="Submit the search query." hidden=""></button></form></div></div><div id="search-results-container" class="z-1 pb-4 px-3 Search_resultsContainer__3RRWL"><p data-testid="results-spacer" class="d-block mt-4"><span> </span></p></div><div class="-z-1 d-none"></div></div></div></div></div></header></div><div class="container-xl px-3 px-md-6 my-4"><div class="Box-nv15kw-0 ArticleGridLayout__Container-sc-we7dhr-0 hgUhMY"><div class="Box-nv15kw-0 imrYun"><span font-size="1" class="Heading-sc-1cjoo9h-0 hdGJqD d-none d-xl-inline-block mb-1">Article version</span><div><details class="Details-ssy9qz-0 brfqyl position-relative details-reset d-inline-block" data-testid="article-version-picker"><summary aria-haspopup="true" class="btn btn-sm"><span class="Text-sc-1s3uzov-0 cEiopf">Free, Pro, & Team</span><div class="Dropdown__DropdownCaret-sc-16yoecj-1 sJQgk"></div></summary><ul direction="sw" style="width:unset" class="Dropdown__DropdownMenu-sc-16yoecj-2 hEUCoC"><li class="Dropdown__DropdownItem-sc-16yoecj-3 knVSGE"><a rel="" href="/web/20211102195623/https://docs.github.com/en/graphql">Free, Pro, & Team</a></li><li class="Dropdown__DropdownItem-sc-16yoecj-3 knVSGE"><a rel="" href="/web/20211102195623/https://docs.github.com/en/enterprise-cloud@latest/graphql">Enterprise Cloud</a></li><li class="Dropdown__DropdownItem-sc-16yoecj-3 knVSGE"><a rel="" href="/web/20211102195623/https://docs.github.com/en/enterprise-server@3.2/graphql">Enterprise Server 3.2</a></li><li class="Dropdown__DropdownItem-sc-16yoecj-3 knVSGE"><a rel="" href="/web/20211102195623/https://docs.github.com/en/enterprise-server@3.1/graphql">Enterprise Server 3.1</a></li><li class="Dropdown__DropdownItem-sc-16yoecj-3 knVSGE"><a rel="" href="/web/20211102195623/https://docs.github.com/en/enterprise-server@3.0/graphql">Enterprise Server 3.0</a></li><li class="Dropdown__DropdownItem-sc-16yoecj-3 knVSGE"><a rel="" href="/web/20211102195623/https://docs.github.com/en/github-ae@latest/graphql">GitHub AE</a></li><div class="Box-nv15kw-0 gTUBqP"><a rel="" class="f6 no-underline color-fg-muted pl-3 pr-2 no-wrap" href="/web/20211102195623/https://docs.github.com/en/enterprise-server@3.2/admin/all-releases">All Enterprise releases <svg aria-hidden="true" role="img" class="mr-2" viewbox="0 0 16 16" width="15" height="15" fill="currentColor" style="display:inline-block;user-select:none;vertical-align:middle;overflow:visible"><path fill-rule="evenodd" d="M8.22 2.97a.75.75 0 011.06 0l4.25 4.25a.75.75 0 010 1.06l-4.25 4.25a.75.75 0 01-1.06-1.06l2.97-2.97H3.75a.75.75 0 010-1.5h7.44L8.22 4.03a.75.75 0 010-1.06z"></path></svg></a></div></ul></details></div></div><div data-search="article-body" class="Box-nv15kw-0 kQOfLl"><div class="d-flex flex-items-baseline flex-justify-between"><h1 class="border-bottom-0">GitHub GraphQL API</h1></div><div class="f2 color-fg-muted mb-3 Lead_container__7YW6Y">You can use the GitHub GraphQL API to create precise and flexible queries for the data you need to integrate with GitHub.</div><div class="border-bottom border-xl-0 pb-4 mb-5 pb-xl-2 mb-xl-2"></div><div class="mt-7"><ul data-testid="table-of-contents" class="list-style-none"><li class="mb-3 border-bottom pb-2"><a rel="" data-testid="bump-link" class="BumpLink_container__jkn7q no-underline d-block py-1" href="/web/20211102195623/https://docs.github.com/en/graphql/overview"><h2 class="h4">Overview<span class="BumpLink_symbol__1kqFd">→</span></h2><p class="f4 color-fg-muted">Learn about the GitHub GraphQL API, previews for upcoming changes, breaking changes, and limitations. You can also use the GraphQL Explorer to interact with the API on real GitHub data.</p></a></li><li class="mb-3 border-bottom pb-2"><a rel="" data-testid="bump-link" class="BumpLink_container__jkn7q no-underline d-block py-1" href="/web/20211102195623/https://docs.github.com/en/graphql/reference"><h2 class="h4">Reference<span class="BumpLink_symbol__1kqFd">→</span></h2><p class="f4 color-fg-muted">View reference documentation to learn about the data types available in the GitHub GraphQL API schema.</p></a></li><li class="mb-3 border-bottom pb-2"><a rel="" data-testid="bump-link" class="BumpLink_container__jkn7q no-underline d-block py-1" href="/web/20211102195623/https://docs.github.com/en/graphql/guides"><h2 class="h4">Guides<span class="BumpLink_symbol__1kqFd">→</span></h2><p class="f4 color-fg-muted">Learn about getting started with GraphQL, migrating from REST to GraphQL, and how to use the GitHub GraphQL API for a variety of tasks.</p></a></li></ul></div></div></div></div><section class="container-xl mt-lg-8 mt-6 px-3 px-md-6 no-print mx-auto"><div class="container-xl mx-auto py-6 py-lg-6 clearfix border-top border-color-secondary"><div class="col-12 col-lg-6 col-xl-3 mb-6 mb-xl-0 float-left pr-4"><form class="f5" data-testid="survey-form"><h2 class="f4 mb-3">Did this doc help you?</h2><input type="text" class="d-none" name="survey-token" aria-hidden="true"/><div class="radio-group mb-2"><input type="radio" id="survey-yes" name="survey-vote" value="Y" aria-label="Yes" hidden=""/><label class="btn mr-1" for="survey-yes"><svg aria-hidden="true" role="img" class="color-fg-muted" viewbox="0 0 16 16" width="16" height="16" fill="currentColor" style="display:inline-block;user-select:none;vertical-align:text-bottom;overflow:visible"><path fill-rule="evenodd" d="M8.834.066C7.494-.087 6.5 1.048 6.5 2.25v.5c0 1.329-.647 2.124-1.318 2.614-.328.24-.66.403-.918.508A1.75 1.75 0 002.75 5h-1A1.75 1.75 0 000 6.75v7.5C0 15.216.784 16 1.75 16h1a1.75 1.75 0 001.662-1.201c.525.075 1.067.229 1.725.415.152.043.31.088.475.133 1.154.32 2.54.653 4.388.653 1.706 0 2.97-.153 3.722-1.14.353-.463.537-1.042.668-1.672.118-.56.208-1.243.313-2.033l.04-.306c.25-1.869.265-3.318-.188-4.316a2.418 2.418 0 00-1.137-1.2C13.924 5.085 13.353 5 12.75 5h-1.422l.015-.113c.07-.518.157-1.17.157-1.637 0-.922-.151-1.719-.656-2.3-.51-.589-1.247-.797-2.01-.884zM4.5 13.3c.705.088 1.39.284 2.072.478l.441.125c1.096.305 2.334.598 3.987.598 1.794 0 2.28-.223 2.528-.549.147-.193.276-.505.394-1.07.105-.502.188-1.124.295-1.93l.04-.3c.25-1.882.189-2.933-.068-3.497a.922.922 0 00-.442-.48c-.208-.104-.52-.174-.997-.174H11c-.686 0-1.295-.577-1.206-1.336.023-.192.05-.39.076-.586.065-.488.13-.97.13-1.328 0-.809-.144-1.15-.288-1.316-.137-.158-.402-.304-1.048-.378C8.357 1.521 8 1.793 8 2.25v.5c0 1.922-.978 3.128-1.933 3.825a5.861 5.861 0 01-1.567.81V13.3zM2.75 6.5a.25.25 0 01.25.25v7.5a.25.25 0 01-.25.25h-1a.25.25 0 01-.25-.25v-7.5a.25.25 0 01.25-.25h1z"></path></svg></label><input type="radio" id="survey-no" name="survey-vote" value="N" aria-label="No" hidden=""/><label class="btn" for="survey-no"><svg aria-hidden="true" role="img" class="color-fg-muted" viewbox="0 0 16 16" width="16" height="16" fill="currentColor" style="display:inline-block;user-select:none;vertical-align:text-bottom;overflow:visible"><path fill-rule="evenodd" d="M7.083 15.986c1.34.153 2.334-.982 2.334-2.183v-.5c0-1.329.646-2.123 1.317-2.614.329-.24.66-.403.919-.508a1.75 1.75 0 001.514.872h1a1.75 1.75 0 001.75-1.75v-7.5a1.75 1.75 0 00-1.75-1.75h-1a1.75 1.75 0 00-1.662 1.2c-.525-.074-1.068-.228-1.726-.415L9.305.705C8.151.385 6.765.053 4.917.053c-1.706 0-2.97.152-3.722 1.139-.353.463-.537 1.042-.669 1.672C.41 3.424.32 4.108.214 4.897l-.04.306c-.25 1.869-.266 3.318.188 4.316.244.537.622.943 1.136 1.2.495.248 1.066.334 1.669.334h1.422l-.015.112c-.07.518-.157 1.17-.157 1.638 0 .921.151 1.718.655 2.299.512.589 1.248.797 2.011.884zm4.334-13.232c-.706-.089-1.39-.284-2.072-.479a63.914 63.914 0 00-.441-.125c-1.096-.304-2.335-.597-3.987-.597-1.794 0-2.28.222-2.529.548-.147.193-.275.505-.393 1.07-.105.502-.188 1.124-.295 1.93l-.04.3c-.25 1.882-.19 2.933.067 3.497a.921.921 0 00.443.48c.208.104.52.175.997.175h1.75c.685 0 1.295.577 1.205 1.335-.022.192-.049.39-.075.586-.066.488-.13.97-.13 1.329 0 .808.144 1.15.288 1.316.137.157.401.303 1.048.377.307.035.664-.237.664-.693v-.5c0-1.922.978-3.127 1.932-3.825a5.862 5.862 0 011.568-.809V2.754zm1.75 6.798a.25.25 0 01-.25-.25v-7.5a.25.25 0 01.25-.25h1a.25.25 0 01.25.25v7.5a.25.25 0 01-.25.25h-1z"></path></svg></label></div><a rel="" class="f6 text-normal color-fg-accent" target="_blank" href="/web/20211102195623/https://docs.github.com/github/site-policy/github-privacy-statement">Privacy policy</a></form></div><div class="col-12 col-lg-6 col-xl-4 mb-6 mb-xl-0 float-left pr-4 offset-xl-1"><div class="f5 contribution"><h2 class="f4 mb-3">Help us make these docs great!</h2><p class="max-w-xs color-fg-muted mb-3">All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.</p><a class="btn" href="https://web.archive.org/web/20211102195623/https://github.com/github/docs/edit/main/content/graphql/index.md"><svg aria-hidden="true" role="img" class="octicon mr-1" viewbox="0 0 16 16" width="16" height="16" fill="currentColor" style="display:inline-block;user-select:none;vertical-align:text-bottom;overflow:visible"><path fill-rule="evenodd" d="M7.177 3.073L9.573.677A.25.25 0 0110 .854v4.792a.25.25 0 01-.427.177L7.177 3.427a.25.25 0 010-.354zM3.75 2.5a.75.75 0 100 1.5.75.75 0 000-1.5zm-2.25.75a2.25 2.25 0 113 2.122v5.256a2.251 2.251 0 11-1.5 0V5.372A2.25 2.25 0 011.5 3.25zM11 2.5h-1V4h1a1 1 0 011 1v5.628a2.251 2.251 0 101.5 0V5A2.5 2.5 0 0011 2.5zm1 10.25a.75.75 0 111.5 0 .75.75 0 01-1.5 0zM3.75 12a.75.75 0 100 1.5.75.75 0 000-1.5z"></path></svg>Make a contribution</a><p class="color-fg-muted f6 mt-2">Or, <a href="https://web.archive.org/web/20211102195623/https://github.com/github/docs/blob/main/CONTRIBUTING.md" target="_blank" rel="noopener">learn how to contribute.</a></p></div></div><div class="col-12 col-lg-12 col-xl-3 float-left pr-4 offset-xl-1"><div><h2 class="mb-3 f4">Still need help?</h2><div class="mb-2"><a id="ask-community" href="https://web.archive.org/web/20211102195623/https://github.community/" class="Link—secondary text-bold"><svg aria-hidden="true" role="img" class="octicon mr-1" viewbox="0 0 16 16" width="16" height="16" fill="currentColor" style="display:inline-block;user-select:none;vertical-align:text-bottom;overflow:visible"><path fill-rule="evenodd" d="M5.5 3.5a2 2 0 100 4 2 2 0 000-4zM2 5.5a3.5 3.5 0 115.898 2.549 5.507 5.507 0 013.034 4.084.75.75 0 11-1.482.235 4.001 4.001 0 00-7.9 0 .75.75 0 01-1.482-.236A5.507 5.507 0 013.102 8.05 3.49 3.49 0 012 5.5zM11 4a.75.75 0 100 1.5 1.5 1.5 0 01.666 2.844.75.75 0 00-.416.672v.352a.75.75 0 00.574.73c1.2.289 2.162 1.2 2.522 2.372a.75.75 0 101.434-.44 5.01 5.01 0 00-2.56-3.012A3 3 0 0011 4z"></path></svg>Ask the GitHub community</a></div><div><a id="contact-us" href="https://web.archive.org/web/20211102195623/https://support.github.com/contact" class="Link—secondary text-bold"><svg aria-hidden="true" role="img" class="octicon mr-1" viewbox="0 0 16 16" width="16" height="16" fill="currentColor" style="display:inline-block;user-select:none;vertical-align:text-bottom;overflow:visible"><path fill-rule="evenodd" d="M1.5 2.75a.25.25 0 01.25-.25h8.5a.25.25 0 01.25.25v5.5a.25.25 0 01-.25.25h-3.5a.75.75 0 00-.53.22L3.5 11.44V9.25a.75.75 0 00-.75-.75h-1a.25.25 0 01-.25-.25v-5.5zM1.75 1A1.75 1.75 0 000 2.75v5.5C0 9.216.784 10 1.75 10H2v1.543a1.457 1.457 0 002.487 1.03L7.061 10h3.189A1.75 1.75 0 0012 8.25v-5.5A1.75 1.75 0 0010.25 1h-8.5zM14.5 4.75a.25.25 0 00-.25-.25h-.5a.75.75 0 110-1.5h.5c.966 0 1.75.784 1.75 1.75v5.5A1.75 1.75 0 0114.25 12H14v1.543a1.457 1.457 0 01-2.487 1.03L9.22 12.28a.75.75 0 111.06-1.06l2.22 2.22v-2.19a.75.75 0 01.75-.75h1a.25.25 0 00.25-.25v-5.5z"></path></svg>Contact support</a></div></div></div></div></section><footer class="container-xl px-3 mt-6 mb-8 px-md-6 position-relative d-flex flex-row-reverse flex-xl-row flex-wrap flex-xl-nowrap flex-justify-center flex-xl-justify-between f6 color-fg-muted"><ul class="list-style-none d-flex flex-wrap col-12 col-xl-5 flex-justify-center flex-xl-justify-between mb-2 mb-xl-0"><li class="mr-3 mr-xl-0">© 2021 GitHub, Inc.</li><li class="mr-3 mr-xl-0"><a href="https://web.archive.org/web/20211102195623/https://docs.github.com/en/github/site-policy/github-terms-of-service">Terms</a></li><li class="mr-3 mr-xl-0"><a href="https://web.archive.org/web/20211102195623/https://docs.github.com/en/github/site-policy/github-privacy-statement">Privacy</a></li><li class="mr-3 mr-xl-0"><a href="https://web.archive.org/web/20211102195623/https://github.com/security">Security</a></li><li class="mr-3 mr-xl-0"><a href="https://web.archive.org/web/20211102195623/https://www.githubstatus.com/">Status</a></li><li><a href="/web/20211102195623/https://docs.github.com/">Help</a></li></ul><a aria-label="Homepage" title="GitHub" class="d-none d-xl-block color-fg-muted" href="https://web.archive.org/web/20211102195623/https://github.com/"><svg aria-hidden="true" role="img" class="octicon octicon-mark-github" viewbox="0 0 16 16" width="24" height="24" fill="currentColor" style="display:inline-block;user-select:none;vertical-align:text-bottom;overflow:visible"><path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0016 8c0-4.42-3.58-8-8-8z"></path></svg></a><ul class="list-style-none d-flex flex-wrap col-12 col-xl-5 flex-justify-center flex-xl-justify-between mb-2 mb-xl-0"><li class="mr-3 mr-xl-0"><a href="https://web.archive.org/web/20211102195623/https://support.github.com/">Contact GitHub</a></li><li class="mr-3 mr-xl-0"><a href="https://web.archive.org/web/20211102195623/https://github.com/pricing">Pricing</a></li><li class="mr-3 mr-xl-0"><a href="https://web.archive.org/web/20211102195623/https://docs.github.com/">Developer API</a></li><li class="mr-3 mr-xl-0"><a href="https://web.archive.org/web/20211102195623/https://services.github.com/">Training</a></li><li class="mr-3 mr-xl-0"><a href="https://web.archive.org/web/20211102195623/https://github.blog/">Blog</a></li><li><a href="https://web.archive.org/web/20211102195623/https://github.com/about">About</a></li></ul></footer><div class="position-fixed bottom-0 mb-4 right-0 mr-4 transition-200 opacity-0"><button class="tooltipped tooltipped-n tooltipped-no-delay color-bg-accent-emphasis color-fg-on-emphasis circle border-0" style="width:40px;height:40px" aria-label="Scroll to top"><svg aria-hidden="true" role="img" class="octicon octicon-chevron-up" viewbox="0 0 16 16" width="16" height="16" fill="currentColor" style="display:inline-block;user-select:none;vertical-align:text-bottom;overflow:visible"><path fill-rule="evenodd" d="M3.22 9.78a.75.75 0 010-1.06l4.25-4.25a.75.75 0 011.06 0l4.25 4.25a.75.75 0 01-1.06 1.06L8 6.06 4.28 9.78a.75.75 0 01-1.06 0z"></path></svg></button></div></main></div></div><script id="__NEXT_DATA__" type="application/json">{"props":{"pageProps":{"mainContext":{"breadcrumbs":[{"documentType":"product","href":"/en/graphql","title":"GraphQL API"}],"activeProducts":[{"id":"get-started","name":"Get started","href":"/get-started","dir":"content/get-started","toc":"content/get-started/index.md","wip":false,"hidden":false,"versions":["free-pro-team@latest","enterprise-cloud@latest","enterprise-server@3.2","enterprise-server@3.1","enterprise-server@3.0","github-ae@latest"]},{"id":"account-and-profile","name":"Account and profile","href":"/account-and-profile","dir":"content/account-and-profile","toc":"content/account-and-profile/index.md","wip":false,"hidden":false,"versions":["free-pro-team@latest","enterprise-cloud@latest","enterprise-server@3.2","enterprise-server@3.1","enterprise-server@3.0","github-ae@latest"]},{"id":"authentication","name":"Authentication","href":"/authentication","dir":"content/authentication","toc":"content/authentication/index.md","wip":false,"hidden":false,"versions":["free-pro-team@latest","enterprise-cloud@latest","enterprise-server@3.2","enterprise-server@3.1","enterprise-server@3.0","github-ae@latest"]},{"id":"repositories","name":"Repositories","href":"/repositories","dir":"content/repositories","toc":"content/repositories/index.md","wip":false,"hidden":false,"versions":["free-pro-team@latest","enterprise-cloud@latest","enterprise-server@3.2","enterprise-server@3.1","enterprise-server@3.0","github-ae@latest"]},{"id":"github","name":"GitHub","href":"/github","dir":"content/github","toc":"content/github/index.md","wip":false,"hidden":false,"versions":["free-pro-team@latest","enterprise-cloud@latest","enterprise-server@3.2","enterprise-server@3.1","enterprise-server@3.0","github-ae@latest"]},{"id":"admin","name":"Enterprise administrators","href":"/enterprise-cloud@latest/admin","dir":"content/admin","toc":"content/admin/index.md","wip":false,"hidden":false,"versions":["enterprise-cloud@latest","enterprise-server@3.2","enterprise-server@3.1","enterprise-server@3.0","github-ae@latest"]},{"id":"billing","name":"Billing and payments","href":"/billing","dir":"content/billing","toc":"content/billing/index.md","wip":false,"hidden":false,"versions":["free-pro-team@latest","enterprise-cloud@latest","enterprise-server@3.2","enterprise-server@3.1","enterprise-server@3.0","github-ae@latest"]},{"id":"organizations","name":"Organizations","href":"/organizations","dir":"content/organizations","toc":"content/organizations/index.md","wip":false,"hidden":false,"versions":["free-pro-team@latest","enterprise-cloud@latest","enterprise-server@3.2","enterprise-server@3.1","enterprise-server@3.0","github-ae@latest"]},{"id":"code-security","name":"Code security","href":"/code-security","dir":"content/code-security","toc":"content/code-security/index.md","wip":false,"hidden":false,"versions":["free-pro-team@latest","enterprise-cloud@latest","enterprise-server@3.2","enterprise-server@3.1","enterprise-server@3.0","github-ae@latest"]},{"id":"pull-requests","name":"Pull requests","href":"/pull-requests","dir":"content/pull-requests","toc":"content/pull-requests/index.md","wip":false,"hidden":false,"versions":["free-pro-team@latest","enterprise-cloud@latest","enterprise-server@3.2","enterprise-server@3.1","enterprise-server@3.0","github-ae@latest"]},{"id":"issues","name":"GitHub Issues","href":"/issues","dir":"content/issues","toc":"content/issues/index.md","wip":false,"hidden":false,"versions":["free-pro-team@latest","enterprise-cloud@latest","enterprise-server@3.2","enterprise-server@3.1","enterprise-server@3.0","github-ae@latest"]},{"id":"actions","name":"GitHub Actions","href":"/actions","dir":"content/actions","toc":"content/actions/index.md","wip":false,"hidden":false,"versions":["free-pro-team@latest","enterprise-cloud@latest","enterprise-server@3.2","enterprise-server@3.1","enterprise-server@3.0","github-ae@latest"]},{"id":"codespaces","name":"GitHub Codespaces","href":"/codespaces","dir":"content/codespaces","toc":"content/codespaces/index.md","wip":false,"hidden":false,"versions":["free-pro-team@latest","enterprise-cloud@latest"]},{"id":"packages","name":"GitHub Packages","href":"/packages","dir":"content/packages","toc":"content/packages/index.md","wip":false,"hidden":false,"versions":["free-pro-team@latest","enterprise-cloud@latest","enterprise-server@3.2","enterprise-server@3.1","enterprise-server@3.0","github-ae@latest"]},{"id":"search-github","name":"Search on GitHub","href":"/search-github","dir":"content/search-github","toc":"content/search-github/index.md","wip":false,"hidden":false,"versions":["free-pro-team@latest","enterprise-cloud@latest","enterprise-server@3.2","enterprise-server@3.1","enterprise-server@3.0","github-ae@latest"]},{"id":"developers","name":"Developers","href":"/developers","dir":"content/developers","toc":"content/developers/index.md","wip":false,"hidden":false,"versions":["free-pro-team@latest","enterprise-cloud@latest","enterprise-server@3.2","enterprise-server@3.1","enterprise-server@3.0","github-ae@latest"]},{"id":"rest","name":"REST API","href":"/rest","dir":"content/rest","toc":"content/rest/index.md","wip":false,"hidden":false,"versions":["free-pro-team@latest","enterprise-cloud@latest","enterprise-server@3.2","enterprise-server@3.1","enterprise-server@3.0","github-ae@latest"]},{"id":"graphql","name":"GraphQL API","href":"/graphql","dir":"content/graphql","toc":"content/graphql/index.md","wip":false,"hidden":false,"versions":["free-pro-team@latest","enterprise-cloud@latest","enterprise-server@3.2","enterprise-server@3.1","enterprise-server@3.0","github-ae@latest"]},{"id":"github-cli","name":"GitHub CLI","href":"/github-cli","dir":"content/github-cli","toc":"content/github-cli/index.md","wip":false,"hidden":false,"versions":["free-pro-team@latest","enterprise-cloud@latest","enterprise-server@3.2","enterprise-server@3.1","enterprise-server@3.0","github-ae@latest"]},{"id":"discussions","name":"GitHub Discussions","href":"/discussions","dir":"content/discussions","toc":"content/discussions/index.md","wip":false,"hidden":false,"versions":["free-pro-team@latest","enterprise-cloud@latest"]},{"id":"sponsors","name":"GitHub Sponsors","href":"/sponsors","dir":"content/sponsors","toc":"content/sponsors/index.md","wip":false,"hidden":false,"versions":["free-pro-team@latest","enterprise-cloud@latest"]},{"id":"communities","name":"Building communities","href":"/communities","dir":"content/communities","toc":"content/communities/index.md","wip":false,"hidden":false,"versions":["free-pro-team@latest","enterprise-cloud@latest","enterprise-server@3.2","enterprise-server@3.1","enterprise-server@3.0","github-ae@latest"]},{"id":"pages","name":"GitHub Pages","href":"/pages","dir":"content/pages","toc":"content/pages/index.md","wip":false,"hidden":false,"versions":["free-pro-team@latest","enterprise-cloud@latest","enterprise-server@3.2","enterprise-server@3.1","enterprise-server@3.0","github-ae@latest"]},{"id":"education","name":"Education","href":"/education","dir":"content/education","toc":"content/education/index.md","wip":false,"hidden":false,"versions":["free-pro-team@latest"]},{"id":"desktop","name":"GitHub Desktop","href":"/desktop","dir":"content/desktop","toc":"content/desktop/index.md","wip":false,"hidden":false,"versions":["free-pro-team@latest"]},{"id":"atom","name":"Atom","href":"https://web.archive.org/web/20211102195623/https://atom.io/docs","external":true},{"id":"electron","name":"Electron","href":"https://web.archive.org/web/20211102195623/https://electronjs.org/docs","external":true},{"id":"codeql","name":"CodeQL","href":"https://web.archive.org/web/20211102195623/https://codeql.github.com/docs","external":true},{"id":"npm","name":"npm","href":"https://web.archive.org/web/20211102195623/https://docs.npmjs.com/","external":true}],"productGroups":[{"name":"Get started","icon":null,"octicon":"RocketIcon","children":[{"id":"get-started","name":"Get started","href":"/get-started","dir":"content/get-started","toc":"content/get-started/index.md","wip":false,"hidden":false,"versions":["free-pro-team@latest","enterprise-cloud@latest","enterprise-server@3.2","enterprise-server@3.1","enterprise-server@3.0","github-ae@latest"]},{"id":"account-and-profile","name":"Account and profile","href":"/account-and-profile","dir":"content/account-and-profile","toc":"content/account-and-profile/index.md","wip":false,"hidden":false,"versions":["free-pro-team@latest","enterprise-cloud@latest","enterprise-server@3.2","enterprise-server@3.1","enterprise-server@3.0","github-ae@latest"]},{"id":"authentication","name":"Authentication","href":"/authentication","dir":"content/authentication","toc":"content/authentication/index.md","wip":false,"hidden":false,"versions":["free-pro-team@latest","enterprise-cloud@latest","enterprise-server@3.2","enterprise-server@3.1","enterprise-server@3.0","github-ae@latest"]},{"id":"billing","name":"Billing and payments","href":"/billing","dir":"content/billing","toc":"content/billing/index.md","wip":false,"hidden":false,"versions":["free-pro-team@latest","enterprise-cloud@latest","enterprise-server@3.2","enterprise-server@3.1","enterprise-server@3.0","github-ae@latest"]}]},{"name":"Collaborative coding","icon":null,"octicon":"CommentDiscussionIcon","children":[{"id":"codespaces","name":"GitHub Codespaces","href":"/codespaces","dir":"content/codespaces","toc":"content/codespaces/index.md","wip":false,"hidden":false,"versions":["free-pro-team@latest","enterprise-cloud@latest"]},{"id":"repositories","name":"Repositories","href":"/repositories","dir":"content/repositories","toc":"content/repositories/index.md","wip":false,"hidden":false,"versions":["free-pro-team@latest","enterprise-cloud@latest","enterprise-server@3.2","enterprise-server@3.1","enterprise-server@3.0","github-ae@latest"]},{"id":"pull-requests","name":"Pull requests","href":"/pull-requests","dir":"content/pull-requests","toc":"content/pull-requests/index.md","wip":false,"hidden":false,"versions":["free-pro-team@latest","enterprise-cloud@latest","enterprise-server@3.2","enterprise-server@3.1","enterprise-server@3.0","github-ae@latest"]},{"id":"discussions","name":"GitHub Discussions","href":"/discussions","dir":"content/discussions","toc":"content/discussions/index.md","wip":false,"hidden":false,"versions":["free-pro-team@latest","enterprise-cloud@latest"]}]},{"name":"CI/CD and DevOps","icon":null,"octicon":"GearIcon","children":[{"id":"actions","name":"GitHub Actions","href":"/actions","dir":"content/actions","toc":"content/actions/index.md","wip":false,"hidden":false,"versions":["free-pro-team@latest","enterprise-cloud@latest","enterprise-server@3.2","enterprise-server@3.1","enterprise-server@3.0","github-ae@latest"]},{"id":"packages","name":"GitHub Packages","href":"/packages","dir":"content/packages","toc":"content/packages/index.md","wip":false,"hidden":false,"versions":["free-pro-team@latest","enterprise-cloud@latest","enterprise-server@3.2","enterprise-server@3.1","enterprise-server@3.0","github-ae@latest"]},{"id":"pages","name":"GitHub Pages","href":"/pages","dir":"content/pages","toc":"content/pages/index.md","wip":false,"hidden":false,"versions":["free-pro-team@latest","enterprise-cloud@latest","enterprise-server@3.2","enterprise-server@3.1","enterprise-server@3.0","github-ae@latest"]}]},{"name":"Security","icon":null,"octicon":"ShieldLockIcon","children":[{"id":"code-security","name":"Code security","href":"/code-security","dir":"content/code-security","toc":"content/code-security/index.md","wip":false,"hidden":false,"versions":["free-pro-team@latest","enterprise-cloud@latest","enterprise-server@3.2","enterprise-server@3.1","enterprise-server@3.0","github-ae@latest"]}]},{"name":"Client apps","icon":null,"octicon":"DeviceMobileIcon","children":[{"id":"github-cli","name":"GitHub CLI","href":"/github-cli","dir":"content/github-cli","toc":"content/github-cli/index.md","wip":false,"hidden":false,"versions":["free-pro-team@latest","enterprise-cloud@latest","enterprise-server@3.2","enterprise-server@3.1","enterprise-server@3.0","github-ae@latest"]},{"id":"desktop","name":"GitHub Desktop","href":"/desktop","dir":"content/desktop","toc":"content/desktop/index.md","wip":false,"hidden":false,"versions":["free-pro-team@latest"]}]},{"name":"Project management","icon":null,"octicon":"ProjectIcon","children":[{"id":"issues","name":"GitHub Issues","href":"/issues","dir":"content/issues","toc":"content/issues/index.md","wip":false,"hidden":false,"versions":["free-pro-team@latest","enterprise-cloud@latest","enterprise-server@3.2","enterprise-server@3.1","enterprise-server@3.0","github-ae@latest"]},{"id":"search-github","name":"Search on GitHub","href":"/search-github","dir":"content/search-github","toc":"content/search-github/index.md","wip":false,"hidden":false,"versions":["free-pro-team@latest","enterprise-cloud@latest","enterprise-server@3.2","enterprise-server@3.1","enterprise-server@3.0","github-ae@latest"]}]},{"name":"Developers","icon":null,"octicon":"MarkGithubIcon","children":[{"id":"developers","name":"Developers","href":"/developers","dir":"content/developers","toc":"content/developers/index.md","wip":false,"hidden":false,"versions":["free-pro-team@latest","enterprise-cloud@latest","enterprise-server@3.2","enterprise-server@3.1","enterprise-server@3.0","github-ae@latest"]},{"id":"rest","name":"REST API","href":"/rest","dir":"content/rest","toc":"content/rest/index.md","wip":false,"hidden":false,"versions":["free-pro-team@latest","enterprise-cloud@latest","enterprise-server@3.2","enterprise-server@3.1","enterprise-server@3.0","github-ae@latest"]},{"id":"graphql","name":"GraphQL API","href":"/graphql","dir":"content/graphql","toc":"content/graphql/index.md","wip":false,"hidden":false,"versions":["free-pro-team@latest","enterprise-cloud@latest","enterprise-server@3.2","enterprise-server@3.1","enterprise-server@3.0","github-ae@latest"]}]},{"name":"Enterprise and Teams","icon":null,"octicon":"OrganizationIcon","children":[{"id":"organizations","name":"Organizations","href":"/organizations","dir":"content/organizations","toc":"content/organizations/index.md","wip":false,"hidden":false,"versions":["free-pro-team@latest","enterprise-cloud@latest","enterprise-server@3.2","enterprise-server@3.1","enterprise-server@3.0","github-ae@latest"]},{"id":"admin","name":"Enterprise administrators","href":"/enterprise-cloud@latest/admin","dir":"content/admin","toc":"content/admin/index.md","wip":false,"hidden":false,"versions":["enterprise-cloud@latest","enterprise-server@3.2","enterprise-server@3.1","enterprise-server@3.0","github-ae@latest"]}]},{"name":"Community","icon":null,"octicon":"GlobeIcon","children":[{"id":"communities","name":"Building communities","href":"/communities","dir":"content/communities","toc":"content/communities/index.md","wip":false,"hidden":false,"versions":["free-pro-team@latest","enterprise-cloud@latest","enterprise-server@3.2","enterprise-server@3.1","enterprise-server@3.0","github-ae@latest"]},{"id":"sponsors","name":"GitHub Sponsors","href":"/sponsors","dir":"content/sponsors","toc":"content/sponsors/index.md","wip":false,"hidden":false,"versions":["free-pro-team@latest","enterprise-cloud@latest"]},{"id":"education","name":"Education","href":"/education","dir":"content/education","toc":"content/education/index.md","wip":false,"hidden":false,"versions":["free-pro-team@latest"]}]}],"communityRedirect":{},"currentProduct":{"id":"graphql","name":"GraphQL API","href":"/graphql","dir":"content/graphql","toc":"content/graphql/index.md","wip":false,"hidden":false,"versions":["free-pro-team@latest","enterprise-cloud@latest","enterprise-server@3.2","enterprise-server@3.1","enterprise-server@3.0","github-ae@latest"]},"currentLayoutName":"default","isHomepageVersion":false,"isFPT":true,"error":"","data":{"ui":{"header":{"github_docs":"GitHub Docs","contact":"Contact","notices":{"ghae_silent_launch":"GitHub AE is currently under limited release. Please \u003ca href=\"https://enterprise.github.com/contact\"\u003econtact our Sales Team\u003c/a\u003e to find out more.","release_candidate":" is currently available as a release candidate. For more information, see \"\u003ca href=\"/admin/overview/about-upgrades-to-new-releases\"\u003eAbout upgrades to new releases\u003c/a\u003e.\"","localization_complete":"We publish frequent updates to our documentation, and translation of this page may still be in progress. For the most current information, please visit the \u003ca id=\"to-english-doc\" href=\"/en\"\u003eEnglish documentation\u003c/a\u003e. If there's a problem with translations on this page, please \u003ca href=\"https://github.com/contact?form[subject]=translation%20issue%20on%20docs.github.com\u0026form[comments]=\"\u003elet us know\u003c/a\u003e.","localization_in_progress":"Hello, explorer! This page is under active development or still in translation. For the most up-to-date and accurate information, please visit our \u003ca id=\"to-english-doc\" href=\"/en\"\u003eEnglish documentation\u003c/a\u003e.","early_access":"📣 Please \u003cb\u003edo not share\u003c/b\u003e this URL publicly. This page contains content about an early access feature.","release_notes_use_latest":"Please use the latest release for the latest security, performance, and bug fixes.","ghes_release_notes_upgrade_patch_only":"📣 This is not the \u003ca href=\"#{{ latestPatch }}\"\u003elatest patch release\u003c/a\u003e of Enterprise Server.","ghes_release_notes_upgrade_release_only":"📣 This is not the \u003ca href=\"/enterprise-server@{{ latestRelease }}/admin/release-notes\"\u003elatest release\u003c/a\u003e of Enterprise Server.","ghes_release_notes_upgrade_patch_and_release":"📣 This is not the \u003ca href=\"#{{ latestPatch }}\"\u003elatest patch release\u003c/a\u003e of this release series, and this is not the \u003ca href=\"/enterprise-server@{{ latestRelease }}/admin/release-notes\"\u003elatest release\u003c/a\u003e of Enterprise Server."}},"release_notes":{"banner_text_current":"These changes will roll out over the next one week.","banner_text_past":"These changes rolled out to enterprises during the week of"},"search":{"need_help":"Need help?","placeholder":"Search topics, products...","loading":"Loading","no_results":"No results found"},"homepage":{"explore_by_product":"Explore by product","version_picker":"Version"},"toc":{"getting_started":"Getting started","popular":"Popular","guides":"Guides","whats_new":"What's new"},"pages":{"article_version":"Article version","miniToc":"In this article","contributor_callout":"This article is contributed and maintained by","all_enterprise_releases":"All Enterprise releases"},"errors":{"oops":"Ooops!","something_went_wrong":"It looks like something went wrong.","we_track_errors":"We track these errors automatically, but if the problem persists please feel free to contact us.","page_doesnt_exist":"It looks like this page doesn't exist."},"support":{"still_need_help":"Still need help?","contact_support":"Contact support","ask_community":"Ask the GitHub community"},"survey":{"able_to_find":"Did this doc help you?","yes":"Yes","no":"No","comment_yes_label":"Let us know what we do well","comment_no_label":"Let us know what we can do better","optional":"Optional","required":"Required","email_placeholder":"email@example.com","email_label":"Can we contact you if we have more questions?","send":"Send","feedback":"Thank you! We received your feedback.","not_support":"If you need a reply, please contact support instead.","privacy_policy":"Privacy policy"},"contribution_cta":{"title":"Help us make these docs great!","body":"All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.","button":"Make a contribution","or":"Or,","to_guidelines":"learn how to contribute."},"products":{"graphql":{"reference":{"fields":"Fields","arguments":"Arguments","name":"Name","type":"Type","description":"Description","input_fields":"Input fields","return_fields":"Return fields","implemented_by":"Implemented by","values":"Values","possible_types":"Possible types","preview_notice":"Preview notice","deprecation_notice":"Deprecation notice"}},"rest":{"reference":{"parameters":"Parameters","response":"Response","code_sample":"Code sample","code_samples":"Code samples","preview_notice":"Preview notice","preview_notices":"Preview notices","see_preview_notice":"See preview notice","see_preview_notices":"See preview notices","preview_header_is_required":"This header is \u003cstrong\u003erequired\u003c/strong\u003e"}}},"footer":{"all_rights_reserved":"All rights reserved","terms":"Terms","privacy":"Privacy","security":"Security","product":{"heading":"Product","links":{"features":"Features","security":"Security","enterprise":"Enterprise","case_studies":"Case Studies","pricing":"Pricing","resources":"Resources"}},"platform":{"heading":"Platform","links":{"developer_api":"Developer API","partners":"Partners","atom":"Atom","electron":"Electron","github_desktop":"GitHub Desktop"}},"support":{"heading":"Support","links":{"help":"Help","community_forum":"Community Forum","training":"Training","status":"Status","contact_github":"Contact GitHub"}},"company":{"heading":"Company","links":{"about":"About","blog":"Blog","careers":"Careers","press":"Press","shop":"Shop"}}},"product_landing":{"quickstart":"Quickstart","reference":"Reference","overview":"Overview","guides":"Guides","code_examples":"Code examples","search_code_examples":"Search code examples","show_more":"Show more","explore_people_and_projects":"Explore people and projects","sorry":"Sorry, there is no result for","no_example":"It looks like we don't have an example that fits your filter.","try_another":"Try another filter or add your code example.","no_result":"Sorry, there are no guides that match your filter.","learn":"Learn how to add a code example","communities_using_discussions":"Communities using discussions","add_your_community":"Add your community","sponsor_community":"GitHub Sponsors community","supported_releases":"Supported releases","release_notes_for":"Release notes for","upgrade_from":"Upgrade from","browse_all_docs":"Browse all docs","explore_release_notes":"Explore release notes"},"product_sublanding":{"start":"Start","start_path":"Start path","learning_paths":"{{ productMap[currentProduct].name }} learning paths","learning_paths_desc":"Learning paths are a collection of guides that help you master a particular subject.","guides":"{{ productMap[currentProduct].name }} guides","more_guides":"more guides","load_more":"Load more guides","all_guides":"All {{ productMap[currentProduct].name }} guides","filter_instructions":"Filter the guide list using these controls","filters":{"type":"Type","topic":"Topic","all":"All"},"guides_found":{"multiple":"{n} guides found","one":"1 guide found","none":"No guides found"},"guide_types":{"overview":"Overview","quick_start":"Quickstart","tutorial":"Tutorial","how_to":"How-to guide","reference":"Reference"}},"learning_track_nav":{"prevGuide":"Previous guide","nextGuide":"Next guide"},"toggle_images":{"off":"Images are off, click to show","on":"Images are on, click to hide","hide_single":"Hide image","show_single":"Show image"},"scroll_button":{"scroll_to_top":"Scroll to top"}},"reusables":{"enterprise_deprecation":{"deprecation_details":"No patch releases will be made, even for critical security issues. For better performance, improved security, and new features, \u003ca href=\"/enterprise/admin/guides/installation/upgrading-github-enterprise/\"\u003eupgrade to the latest version of GitHub Enterprise\u003c/a\u003e.\nFor help with the upgrade, \u003ca href=\"https://enterprise.github.com/support\"\u003econtact GitHub Enterprise support\u003c/a\u003e.","version_was_deprecated":"This version of GitHub Enterprise was discontinued on","version_will_be_deprecated":"This version of GitHub Enterprise will be discontinued on"},"policies":{"abuse":"{% data variables.product.prodname_dotcom %} does not tolerate abuse.{% ifversion fpt or ghec %} For more information on {% data variables.product.prodname_dotcom %}'s policies, see our [Terms of Service](/free-pro-team@latest/github/site-policy/github-terms-of-service) and [Community Guidelines](/free-pro-team@latest/github/site-policy/github-community-guidelines).{% endif %}","github-community-guidelines-and-terms":"{% data variables.product.company_short %} provides a baseline code of conduct for everyone who uses {% data variables.product.prodname_dotcom_the_website %}. For more information, see \"[{% data variables.product.company_short %} Terms of Service](/free-pro-team@latest/github/site-policy/github-terms-of-service)\" and \"[{% data variables.product.company_short %} Community Guidelines](/free-pro-team@latest/github/site-policy/github-community-guidelines).\"","translation":"This document is translated from English. In the event of any conflict, uncertainty, or apparent inconsistency between this version and the English version(s) of this document, the English version is the controlling version.\n\nIf you have suggestions to improve our translation, please \u003ca href=\"https://github.com/github/site-policy/issues\"\u003eopen an issue in our site-policy repository\u003c/a\u003e."}},"variables":{"release_candidate":{"version":""}}},"airGap":false,"currentCategory":"","currentPathWithoutLanguage":"/graphql","relativePath":"graphql/index.md","page":{"languageVariants":[{"name":"English","code":"en","hreflang":"en","href":"/en/graphql"},{"name":"Simplified Chinese","code":"cn","hreflang":"zh-Hans","href":"/cn/graphql"},{"name":"Japanese","code":"ja","hreflang":"ja","href":"/ja/graphql"},{"name":"Spanish","code":"es","hreflang":"es","href":"/es/graphql"},{"name":"Portuguese","code":"pt","hreflang":"pt","href":"/pt/graphql"}],"documentType":"product","type":null,"title":"GitHub GraphQL API","fullTitle":"GitHub GraphQL API - GitHub Docs","topics":[],"introPlainText":"You can use the GitHub GraphQL API to create precise and flexible queries for the data you need to integrate with GitHub.","permalinks":[{"title":"GitHub GraphQL API","pageVersionTitle":"Free, Pro, \u0026 Team","pageVersion":"free-pro-team@latest","href":"/en/graphql","relativePath":"graphql/index.md","languageCode":"en"},{"title":"GitHub GraphQL API","pageVersionTitle":"Enterprise Cloud","pageVersion":"enterprise-cloud@latest","href":"/en/enterprise-cloud@latest/graphql","relativePath":"graphql/index.md","languageCode":"en"},{"title":"GitHub GraphQL API","pageVersionTitle":"Enterprise Server 3.2","pageVersion":"enterprise-server@3.2","href":"/en/enterprise-server@3.2/graphql","relativePath":"graphql/index.md","languageCode":"en"},{"title":"GitHub GraphQL API","pageVersionTitle":"Enterprise Server 3.1","pageVersion":"enterprise-server@3.1","href":"/en/enterprise-server@3.1/graphql","relativePath":"graphql/index.md","languageCode":"en"},{"title":"GitHub GraphQL API","pageVersionTitle":"Enterprise Server 3.0","pageVersion":"enterprise-server@3.0","href":"/en/enterprise-server@3.0/graphql","relativePath":"graphql/index.md","languageCode":"en"},{"title":"GitHub GraphQL API","pageVersionTitle":"GitHub AE","pageVersion":"github-ae@latest","href":"/en/github-ae@latest/graphql","relativePath":"graphql/index.md","languageCode":"en"}],"hidden":false},"enterpriseServerReleases":{"isOldestReleaseDeprecated":false,"oldestSupported":"3.0","nextDeprecationDate":"2022-02-16","supported":["3.2","3.1","3.0"]},"enterpriseServerVersions":["enterprise-server@3.2","enterprise-server@3.1","enterprise-server@3.0"],"userLanguage":"en","allVersions":{"free-pro-team@latest":{"version":"free-pro-team@latest","versionTitle":"Free, Pro, \u0026 Team","latestVersion":"free-pro-team@latest","currentRelease":"latest","openApiVersionName":"api.github.com","miscVersionName":"dotcom","plan":"free-pro-team","planTitle":"Free, Pro, \u0026 Team","shortName":"fpt","releases":["latest"],"latestRelease":"latest","nonEnterpriseDefault":true,"openApiBaseName":"api.github.com","miscBaseName":"dotcom"},"enterprise-cloud@latest":{"version":"enterprise-cloud@latest","versionTitle":"Enterprise Cloud","latestVersion":"enterprise-cloud@latest","currentRelease":"latest","openApiVersionName":"api.github.com","miscVersionName":"ghec","plan":"enterprise-cloud","planTitle":"Enterprise Cloud","shortName":"ghec","releases":["latest"],"latestRelease":"latest","openApiBaseName":"api.github.com","miscBaseName":"ghec"},"enterprise-server@3.2":{"version":"enterprise-server@3.2","versionTitle":"Enterprise Server 3.2","latestVersion":"enterprise-server@3.2","currentRelease":"3.2","openApiVersionName":"ghes-3.2","miscVersionName":"ghes-3.2","plan":"enterprise-server","planTitle":"Enterprise Server","shortName":"ghes","releases":["3.2","3.1","3.0"],"latestRelease":"3.2","hasNumberedReleases":true,"openApiBaseName":"ghes-","miscBaseName":"ghes-"},"enterprise-server@3.1":{"version":"enterprise-server@3.1","versionTitle":"Enterprise Server 3.1","latestVersion":"enterprise-server@3.2","currentRelease":"3.1","openApiVersionName":"ghes-3.1","miscVersionName":"ghes-3.1","plan":"enterprise-server","planTitle":"Enterprise Server","shortName":"ghes","releases":["3.2","3.1","3.0"],"latestRelease":"3.2","hasNumberedReleases":true,"openApiBaseName":"ghes-","miscBaseName":"ghes-"},"enterprise-server@3.0":{"version":"enterprise-server@3.0","versionTitle":"Enterprise Server 3.0","latestVersion":"enterprise-server@3.2","currentRelease":"3.0","openApiVersionName":"ghes-3.0","miscVersionName":"ghes-3.0","plan":"enterprise-server","planTitle":"Enterprise Server","shortName":"ghes","releases":["3.2","3.1","3.0"],"latestRelease":"3.2","hasNumberedReleases":true,"openApiBaseName":"ghes-","miscBaseName":"ghes-"},"github-ae@latest":{"version":"github-ae@latest","versionTitle":"GitHub AE","latestVersion":"github-ae@latest","currentRelease":"latest","openApiVersionName":"github.ae","miscVersionName":"ghae","plan":"github-ae","planTitle":"GitHub AE","shortName":"ghae","releases":["latest"],"latestRelease":"latest","openApiBaseName":"github.ae","miscBaseName":"ghae"}},"currentVersion":"free-pro-team@latest","currentProductTree":{"href":"/en/graphql","renderedShortTitle":"GraphQL API","renderedFullTitle":"GitHub GraphQL API","page":{"hidden":false,"documentType":"product","title":"GitHub GraphQL API","shortTitle":"GraphQL API"},"childPages":[{"href":"/en/graphql/overview","renderedShortTitle":"","renderedFullTitle":"Overview","page":{"hidden":false,"documentType":"category","title":"Overview","shortTitle":""},"childPages":[{"href":"/en/graphql/overview/about-the-graphql-api","renderedShortTitle":"","renderedFullTitle":"About the GraphQL API","page":{"hidden":false,"documentType":"article","title":"About the GraphQL API","shortTitle":""},"childPages":[]},{"href":"/en/graphql/overview/public-schema","renderedShortTitle":"","renderedFullTitle":"Public schema","page":{"hidden":false,"documentType":"article","title":"Public schema","shortTitle":""},"childPages":[]},{"href":"/en/graphql/overview/schema-previews","renderedShortTitle":"","renderedFullTitle":"Schema previews","page":{"hidden":false,"documentType":"article","title":"Schema previews","shortTitle":""},"childPages":[]},{"href":"/en/graphql/overview/breaking-changes","renderedShortTitle":"","renderedFullTitle":"Breaking changes","page":{"hidden":false,"documentType":"article","title":"Breaking changes","shortTitle":""},"childPages":[]},{"href":"/en/graphql/overview/changelog","renderedShortTitle":"","renderedFullTitle":"Changelog","page":{"hidden":false,"documentType":"article","title":"Changelog","shortTitle":""},"childPages":[]},{"href":"/en/graphql/overview/explorer","renderedShortTitle":"","renderedFullTitle":"Explorer","page":{"hidden":false,"documentType":"article","title":"Explorer","shortTitle":""},"childPages":[]},{"href":"/en/graphql/overview/resource-limitations","renderedShortTitle":"","renderedFullTitle":"Resource limitations","page":{"hidden":false,"documentType":"article","title":"Resource limitations","shortTitle":""},"childPages":[]}]},{"href":"/en/graphql/reference","renderedShortTitle":"","renderedFullTitle":"Reference","page":{"hidden":false,"documentType":"category","title":"Reference","shortTitle":""},"childPages":[{"href":"/en/graphql/reference/queries","renderedShortTitle":"","renderedFullTitle":"Queries","page":{"hidden":false,"documentType":"article","title":"Queries","shortTitle":""},"childPages":[]},{"href":"/en/graphql/reference/mutations","renderedShortTitle":"","renderedFullTitle":"Mutations","page":{"hidden":false,"documentType":"article","title":"Mutations","shortTitle":""},"childPages":[]},{"href":"/en/graphql/reference/objects","renderedShortTitle":"","renderedFullTitle":"Objects","page":{"hidden":false,"documentType":"article","title":"Objects","shortTitle":""},"childPages":[]},{"href":"/en/graphql/reference/interfaces","renderedShortTitle":"","renderedFullTitle":"Interfaces","page":{"hidden":false,"documentType":"article","title":"Interfaces","shortTitle":""},"childPages":[]},{"href":"/en/graphql/reference/enums","renderedShortTitle":"","renderedFullTitle":"Enums","page":{"hidden":false,"documentType":"article","title":"Enums","shortTitle":""},"childPages":[]},{"href":"/en/graphql/reference/unions","renderedShortTitle":"","renderedFullTitle":"Unions","page":{"hidden":false,"documentType":"article","title":"Unions","shortTitle":""},"childPages":[]},{"href":"/en/graphql/reference/input-objects","renderedShortTitle":"","renderedFullTitle":"Input objects","page":{"hidden":false,"documentType":"article","title":"Input objects","shortTitle":""},"childPages":[]},{"href":"/en/graphql/reference/scalars","renderedShortTitle":"","renderedFullTitle":"Scalars","page":{"hidden":false,"documentType":"article","title":"Scalars","shortTitle":""},"childPages":[]}]},{"href":"/en/graphql/guides","renderedShortTitle":"","renderedFullTitle":"Guides","page":{"hidden":false,"documentType":"category","title":"Guides","shortTitle":""},"childPages":[{"href":"/en/graphql/guides/introduction-to-graphql","renderedShortTitle":"","renderedFullTitle":"Introduction to GraphQL","page":{"hidden":false,"documentType":"article","title":"Introduction to GraphQL","shortTitle":""},"childPages":[]},{"href":"/en/graphql/guides/forming-calls-with-graphql","renderedShortTitle":"Form calls with GraphQL","renderedFullTitle":"Forming calls with GraphQL","page":{"hidden":false,"documentType":"article","title":"Forming calls with GraphQL","shortTitle":"Form calls with GraphQL"},"childPages":[]},{"href":"/en/graphql/guides/using-global-node-ids","renderedShortTitle":"","renderedFullTitle":"Using global node IDs","page":{"hidden":false,"documentType":"article","title":"Using global node IDs","shortTitle":""},"childPages":[]},{"href":"/en/graphql/guides/migrating-from-rest-to-graphql","renderedShortTitle":"Migrate from REST to GraphQL","renderedFullTitle":"Migrating from REST to GraphQL","page":{"hidden":false,"documentType":"article","title":"Migrating from REST to GraphQL","shortTitle":"Migrate from REST to GraphQL"},"childPages":[]},{"href":"/en/graphql/guides/using-the-explorer","renderedShortTitle":"","renderedFullTitle":"Using the Explorer","page":{"hidden":false,"documentType":"article","title":"Using the Explorer","shortTitle":""},"childPages":[]},{"href":"/en/graphql/guides/using-the-graphql-api-for-discussions","renderedShortTitle":"Use GraphQL for Discussions","renderedFullTitle":"Using the GraphQL API for Discussions","page":{"hidden":false,"documentType":"article","title":"Using the GraphQL API for Discussions","shortTitle":"Use GraphQL for Discussions"},"childPages":[]}]}]},"featureFlags":{},"searchVersions":{"free-pro-team@latest":"dotcom","enterprise-cloud@latest":"ghec","enterprise-server@3.2":"3.2","enterprise-server@3.1":"3.1","enterprise-server@3.0":"3.0","github-ae@latest":"ghae"},"nonEnterpriseDefaultVersion":"free-pro-team@latest","status":200,"fullUrl":"https://web.archive.org/web/20211102195623/https://docs.github.com/en/graphql"},"productLandingContext":{"title":"GitHub GraphQL API","shortTitle":"GraphQL API","introPlainText":"You can use the GitHub GraphQL API to create precise and flexible queries for the data you need to integrate with GitHub.","intro":"\u003cp\u003eYou can use the GitHub GraphQL API to create precise and flexible queries for the data you need to integrate with GitHub.\u003c/p\u003e","product_video":"","hasGuidesPage":true,"product":{"href":"/en/graphql","title":"GraphQL API"},"whatsNewChangelog":[],"changelogUrl":[],"productCodeExamples":[],"productCommunityExamples":[],"releases":[],"productUserExamples":[],"introLinks":null,"featuredLinks":{},"tocItems":[],"featuredArticles":[]},"productSubLandingContext":{"intro":"\u003cp\u003eYou can use the GitHub GraphQL API to create precise and flexible queries for the data you need to integrate with GitHub.\u003c/p\u003e","title":"GraphQL API","featuredTrack":null,"learningTracks":[],"includeGuides":[]},"tocLandingContext":{"title":"GitHub GraphQL API","productCallout":"","introPlainText":"You can use the GitHub GraphQL API to create precise and flexible queries for the data you need to integrate with GitHub.","tocItems":[{"fullPath":"/en/graphql/overview","title":"Overview","intro":"Learn about the GitHub GraphQL API, previews for upcoming changes, breaking changes, and limitations. You can also use the GraphQL Explorer to interact with the API on real GitHub data.","childTocItems":null},{"fullPath":"/en/graphql/reference","title":"Reference","intro":"View reference documentation to learn about the data types available in the GitHub GraphQL API schema.","childTocItems":null},{"fullPath":"/en/graphql/guides","title":"Guides","intro":"Learn about getting started with GraphQL, migrating from REST to GraphQL, and how to use the GitHub GraphQL API for a variety of tasks.","childTocItems":null}],"variant":"expanded","featuredLinks":{},"renderedPage":"","currentLearningTrack":{}},"articleContext":{"title":"GitHub GraphQL API","intro":"\u003cp\u003eYou can use the GitHub GraphQL API to create precise and flexible queries for the data you need to integrate with GitHub.\u003c/p\u003e","effectiveDate":"","renderedPage":"","miniTocItems":[],"contributor":null,"permissions":"","includesPlatformSpecificContent":false,"defaultPlatform":"","product":"","currentLearningTrack":{}}},"themeProps":{"colorMode":"auto","nightTheme":"dark","dayTheme":"light"},"csrfToken":"oQiSI7Eg-kqoKSlKl0PypznadlCnUwBqsLvw","languagesContext":{"languages":{"en":{"name":"English","code":"en","hreflang":"en","dir":"","wip":false},"cn":{"name":"Simplified Chinese","nativeName":"简体中文","code":"cn","hreflang":"zh-Hans","redirectPatterns":[{},{}],"dir":"translations/zh-CN","wip":false},"ja":{"name":"Japanese","nativeName":"日本語","code":"ja","hreflang":"ja","redirectPatterns":[{}],"dir":"translations/ja-JP","wip":false},"es":{"name":"Spanish","nativeName":"Español","code":"es","hreflang":"es","dir":"translations/es-ES","wip":false},"pt":{"name":"Portuguese","nativeName":"Português do Brasil","code":"pt","hreflang":"pt","dir":"translations/pt-BR","wip":false}}},"__N_SSP":true},"page":"/[versionId]/[productId]","query":{"versionId":"free-pro-team@latest","productId":"graphql"},"buildId":"JLUjmF_ihwlS7y-ufQZEU","isFallback":false,"gssp":true,"customServer":true,"appGip":true,"locale":"en","locales":["en","cn","ja","es","pt","de"],"defaultLocale":"en","scriptLoader":[]}</script></body></html>