Crystallize logo
Documentation/Developer Guides/Catalogue API/Fetching an Item

Fetching an Item

Each item in Crystallize is a custom-defined shape that can be anything, including a document, a folder or a product. Since the main purpose of the Catalogue API is to fetch items from the catalogue, that is what we will be covering in this section.

In this section

Query FieldsOpen subnavigation for Query FieldsShapeOpen subnavigation for ShapePiecesOpen subnavigation for PiecesComponentsOpen subnavigation for ComponentsFetching All ComponentsOpen subnavigation for Fetching All ComponentsGetting TopicsOpen subnavigation for Getting TopicsFetching Parent ItemsOpen subnavigation for Fetching Parent ItemsQuerying Related ItemsOpen subnavigation for Querying Related ItemsUsing Aliases While QueryingOpen subnavigation for Using Aliases While QueryingPaginationOpen subnavigation for Pagination

In order to perform these operations, ensure that you have the proper authentication (if necessary) and user permissions.

API Endpoint

As mentioned in the previous section, the endpoint to retrieve data from the API is:

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

Fetch a Product

The query below retrieves the basic data for a particular product. You can also retrieve the data for all the products you have in your catalogue.

Fetch a Document

Similar to how the product was fetched in the section above, a document can be retrieved in the same manner. The query below gets the basic information for a document.

Fetch a Folder

Fetching a folder is just as easy. The query below fetches the plants folder that is present in the demo tenant.