Catalogue API

The Catalogue API provides an efficient manner 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.

Base URL

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

https://api.crystallize.com/{your-tenant-name}/catalogue

API Access

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

Head over 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. Go ahead and 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