Collections

What are collections?

Collections are a way to group brands together. A collection can then be used for a variety of purposes to save time when adding brands. Instead of searching for a number of brands every time a user can add the collection in one go. Examples of useful collections are:

• All brands that are part of a company.
• Client brands
• Competitor brands

A collection may be public or private. A public collection is available to all users. A private collection is only available to the user who created it.

A collection can also be shared with any number of users.

List all collections

To list all of the collections and browse them via the API, use the list endpoint:

GET /api/v2/collections

Get a collection

You may also directly retrieve a collection's details if you already have its system ID.

GET /api/v2/collections/123

Where 123 is the system ID of the collection.

Schema

Full response schema

Key	Type	Filterable	Sortable	Configurable	Description
id	integer	✅ (exact)	✅	✅	The system ID.
name	string	✅	✅	✅	The primary name of the collection.
collection_type	string	✅	✅	✅	Whether the collection is private or public.
uuid	-	✅	✅	✅	The public unique identifier for the collection. Whenever a collection is shared outside of the system, or a direct link is required we use the UUID over the ID.
created_at	string	❌	✅	✅	A datetime string when this collection was first created.
updated_at	string	(updated since)	✅	✅	A datetime string when this collection was last updated.

Additional Filters

For convenience, we have a set of additional filters that are not available in the default filters or are part of the columns. These are:

• public - Set to 1 to only return public collections.
• shared_with_me - Set to 1 to only return collections shared with the user.
• mine - Set to 1 to only return collections created by the user.

Searching

This endpoint supports searching. See the searching section for more details.