Atlassian GraphQL Gateway

Atlassian has implemented the GraphQL API at the cloud platform level using a central schema. The Atlassian GraphQL Gateway (AGG) is the platform service that proxies GraphQL requests to multiple GraphQL services and combines the results. Requests will be routed to PAPI where it will undergo partner specific authorization.

Through AGG, partners will have the ability to fetch their data across multiple entities. A complete offering catalog is also available which includes product and app pricing details across both cloud and BTF (behind the firewall) products.

Playground

The AGG Playground is a browser-based, interactive IDE that you can use to run queries and see the results.

Learn more about how to use the AGG Playground

Launch the AGG Playground

Endpoints

The same production endpoint can either can be accessed via a browser, which will take you to the AGG Playground UI, or you can use it for PAPI implementation. The only difference is the HTTP Method used.

PAPI GraphQL Schemas

More on GraphQL

GraphQL is a query language for APIs and a server-side runtime for executing queries. This style of API allows access to linked data, which you can think of as a graph of entities. For example, you can request the work activity of a team of people and get the details for those people in the same request. With other types of APIs - such as REST APIs - this would require many requests, making GraphQL more efficient and flexible to use.

GraphQL APIs are strongly typed, and the type system determines what data can be queried. You can use queries to request data and mutations to write (or modify) data. GraphQL also supports subscriptions.

GraphQL concepts and terminology

Below is a brief overview of key terminology and GraphQL concepts:

• field: A field is a way to get values from an object, as a field is often an attribute of an object. Fields can take arguments (that act like methods on an object).
• graph: An abstract data type (not to be confused with graphs being used to plot functions).
• mutation: The method for writing data. You can create, update, and delete data.
• payload: Everything that follows the root field.
• query: The information used by a client to request data form the server.
• response: The information requested in the payload that is returned to the client. root field: The first field in a query.
• type: Describes what data can be queried, including enum, input, mutation, object types, query, scalar, etc.