Rate this page:
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.
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
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.
|GET||https://api.atlassian.com/graphql||AGG Playgound UI|
|POST||https://api.atlassian.com/graphql||AGG GraphQL API|
|Catalog||Atlassian pricing catalog for both cloud and BTF products, including their related apps|
|More to come!|
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.
Below is a brief overview of key terminology and GraphQL concepts:
If you are new to using GraphQL, we strongly recommend reading Introduction to GraphQL and learning about the Core Concepts.
Rate this page: