Skip to content

Catalogue

Overview

Before reading about the catalogue resource you need to be familiar with moments and souvenirs. Read all about those resources before continuing to learn about what the Catalogue service provides.

The catalogue is not actually a resource in its own right. The Catalogue API provides a single helper endpoint. This endpoint calls various XPKit services on your behalf to determine which souvenirs a visitor has obtained for a particular experience.

See the souvenir collection case study for a good use case for when you might want to use this service.

Using the helper endpoint

You can provide an experience (experience_id) and profile lookup information to the helper endpoint and it will call the Profiles API, Activities API, Moments API and Souvenirs API on your behalf to calculate and return all the souvenirs a visitor has obtained for that experience.