Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.snappy.com/llms.txt

Use this file to discover all available pages before exploring further.

A Collection is a curated catalog of gift items tailored to a specific theme, budget range, and audience (e.g., “Birthday Gifts Under $50”). The gift recipient then chooses their preferred item directly from this collection.
Want to understand how Collections fit into the bigger picture? Check out the Core Concepts & Data Models page.

​
The Collection Object

FieldTypeDescription
idstringUnique identifier for the Collection
namestringDisplay name of the Collection
typesarrayThe category of items in this Collection. Possible values: gifts, swag, local experiences
coverImagestringURL of the Collection’s cover image, used for display in campaign setup and recipient experience
thumbnailsarrayList of URLs of thumbnail images representing items within the Collection
createdBystringThe team or user who created the Collection
createdAtstringISO 8601 timestamp of when the Collection was created
updatedAtstringISO 8601 timestamp of the last update

​
Paginated Response

The Collections endpoint returns a paginated response with the following envelope:
FieldTypeDescription
resultsarrayThe list of Collection objects returned for the current page
skipnumberThe number of items skipped from the start of the list
limitnumberThe maximum number of items returned per page. Default and maximum is 100
For details on how to paginate through large result sets, see Request & Response Standards → Pagination.

​
Key Concepts & Business Rules

​
Collections are read-only via the API

Collections available to your account are curated by Snappy or created via the Snappy Dashboard. You cannot create or modify Collections through the API — only retrieve them.

​
Collection types

The types field indicates the category of items within the Collection. This can be useful for filtering Collections when configuring a Campaign for a specific use case — for example, selecting only swag Collections for a branded merchandise campaign.

​
Assigning a Collection to a Campaign

To use a Collection in a gifting flow, assign its id to a Campaign. Recipients will then browse and select from that Collection when they claim their gift.
A Campaign can be assigned either a Collection or a specific Product — not both. See Campaigns for details.

​
How to Work with Collections

Retrieving Collections Search for and retrieve a list of available Collections based on your specified criteria: 
GET /collections
Filtering options:
  • Budget range
  • Supported countries
  • Collection types (e.g. gifts, swag)
Swag collections can only be retrieved by specifying the accountId in the request.
Retrieving Collection Budgets Retrieve the available minimum and maximum budget ranges for Collections. Budget ranges determine the price points that recipients can choose from when selecting gifts: 
GET /collections/budgets
Filtering options:
  • Budget range
  • Supported countries
Retrieving Products within a Collection Retrieve a list of products available within a specific Collection: 
GET /collections/{id}/products
Filtering options:
  • Budget range
  • Supported countries
Retrieve a specific product from a specific Collection: 
GET /collections/{id}/products/{productId}
The Product objects returned in this response follow the standard Product schema. See Products for the full object structure.
Retrieving the Collection Products Count Retrieve the number of products available within a specific Collection — useful for display purposes or pagination planning before fetching the full product list: 
GET /collections/{id}/products/count
Last modified on April 30, 2026