GraphQL API

Version history

Getting Started

For those new to the GitLab GraphQL API, see Getting started with GitLab GraphQL API.

Quick Reference

Examples

To work with sample queries that pull data from public projects on GitLab.com, see the menu options in the left-hand documentation menu, under API > GraphQL at https://docs.gitlab.com/ee/api/graphql/.

The Getting started page includes different methods to customize GraphQL queries.

GraphiQL

Explore the GraphQL API using the interactive GraphiQL explorer, or on your self-managed GitLab instance on https://<your-gitlab-site.com>/-/graphql-explorer.

See the GitLab GraphQL overview for more information about the GraphiQL Explorer.

What is GraphQL?

GraphQL is a query language for APIs that allows clients to request exactly the data they need, making it possible to get all required data in a limited number of requests.

The GraphQL data (fields) can be described in the form of types, allowing clients to use client-side GraphQL libraries to consume the API and avoid manual parsing.

Since there’s no fixed endpoints and data model, new abilities can be added to the API without creating breaking changes. This allows us to have a versionless API as described in the GraphQL documentation.

Vision

We want the GraphQL API to be the primary means of interacting programmatically with GitLab. To achieve this, it needs full coverage - anything possible in the REST API should also be possible in the GraphQL API.

To help us meet this vision, the frontend should use GraphQL in preference to the REST API for new features.

There are no plans to deprecate the REST API. To reduce the technical burden of supporting two APIs in parallel, they should share implementations as much as possible.

Deprecation process

Fields marked for removal from the GitLab GraphQL API are first deprecated but still available for at least six releases, and then removed entirely. Removals occur at X.0 and X.6 releases.

For example, a field can be marked as deprecated (but still usable) in %12.7, but can be used until its removal in %13.6. When marked as deprecated, an alternative should be provided if there is one. That gives consumers of the GraphQL API a minimum of six months to update their GraphQL queries.

The process is as follows:

  1. The field is listed as deprecated in GraphQL API Reference.
  2. Removals are announced at least one release prior in the Deprecation Warnings section of the release post (at or prior to X.11 and X.5 releases).
  3. Fields meeting criteria are removed in X.0 or X.6.

Available queries

The GraphQL API includes the following queries at the root level:

  1. project : Project information, with many of its associations such as issues and merge requests.
  2. group : Basic group information and epics are currently supported.
  3. user : Information about a particular user.
  4. namespace : Within a namespace it is also possible to fetch projects.
  5. currentUser: Information about the currently logged in user.
  6. users: Information about a collection of users.
  7. metaData: Metadata about GitLab and the GraphQL API.
  8. snippets: Snippets visible to the currently logged in user.

New associations and root level objects are constantly being added. See the GraphQL API Reference for up-to-date information.

Root-level queries are defined in app/graphql/types/query_type.rb.

Multiplex queries

GitLab supports batching queries into a single request using apollo-link-batch-http. More information about multiplexed queries is also available for GraphQL Ruby, the library GitLab uses on the backend.

Reference

GitLab’s GraphQL reference is available.

It is automatically generated from GitLab’s GraphQL schema and embedded in a Markdown file.

Machine-readable versions are also available:

Generate updates for documentation

If you’ve changed the GraphQL schema, you should set up an MR to gain approval of your changes. To generate the required documentation and schema, follow the instructions given in the Rake tasks for developers page.

Be sure to run these commands using the GitLab Development Kit.