Last updated May 4, 2023

Rate this page:

Overview

This example query will return all active products for both BTF (behind the firewall) products as well as cloud products. The product keys can then be used to fetch product details by making an additional query to fetch the offering details.

More on the offering catalog query and response

Use-Case

  • Complete active product list integration into external systems for both cloud and BTF products. e.g. Salesforce
  • Experiences could leverage this query as a back-end service to fetch a list of products by returning necessary fields

GraphQL Query

Launch the AGG Playground

1
2
query FetchOfferingCatalog {
  partnerCatalogApi {
    partnerOfferingCatalog {
      btfProducts {
        productKey
        productDescription
      }
      cloudProducts {
        key
        name
      }
    }
  }
}

cURL

1
2
curl --location 'https://api.atlassian.com/graphql' \
--header 'Authorization: Basic <encrypted_credencials>;' \
--header 'Content-Type: application/json' \
--data '{"query":"query getCatalog{\n    partnerCatalogApi {\n        partnerOfferingCatalog{\n            btfProducts{\n                productKey\n                productDescription\n            }\n            cloudProducts{\n                key\n                name\n            }\n        }\n    }\n}","variables":{}}'

Rate this page: