Skip to main content
More in Learn

Catalogue API

The Catalogue API provides an efficient way to query the catalogue in Crystallize via GraphQL. Using this API, you can easily access any item present in your tenant, including all the products, documents, and folders.

Table of contents
  1. Base URL
  2. API Access
  3. Example Query
  4. cURL Example

Base URL

The Catalogue API can be accessed by using the following endpoint:

https://api.crystallize.com/your-tenant-identifier/catalogue

API Access

By default, the API is accessible without any authentication, but you can change the API access according to your preference:

  • Within the Crystallize App, go to Settings and then select API Access.
  • Choose from one of the options and then click Save.

Example Query

Below is an example query that queries the demo tenant. Press the play button to see the response.

cURL Example

Below is an example of how you can fetch an item from the catalogue via cURL.

curl \
  -X POST \
  -H "Content-Type: application/json" \
  --data '{ "query": "{ catalogue(language: \"en\", path: \"/shop/plants\") { name } }" }' \
  https://api.crystallize.com/furniture/catalogue
People showing thumbs up

Need further assistance?

Ask the Crystallize team or other enthusiasts in our slack community.

Join our slack community