About the Collections API

The Collections API allows you to manage collections in a portfolio. A collection is a way to group similar projects together in your portfolio. Learn more about collections in Wix Portfolio.

With the Collections API, you can:

• Create, update, and delete collections.
• Retrieve and query collections.
• Listen for events when a collection is created, updated, and deleted.

Before you begin

It’s important to note the following points before starting to code:

• After creating a collection, you can assign a new or existing project to the collection by specifying the collection's ID in the collectionIds parameter of the Create Project or Update Project methods.
• You can only use this API on sites where a Wix user has installed the Wix Portfolio app.

Use cases

• Organize photography projects by theme.
• Keep your data current with collection events.

Sample Use Cases and Flows

This article presents possible use cases and corresponding sample flows that you can support. This can be a helpful jumping off point as you plan your implementation.

Organize photography projects by theme

You can develop a photo analyzer to categorize related photography projects into collections based on theme.

1. Call Create Collection to create a collection for projects with a shared theme. Save the returned collection ID for a later step.

2. Analyze your projects and identify those with a shared theme.

3. Use the Projects API to add the projects with a shared theme to the collection by assigning the saved collection ID to each project.

4. Call Get Collection to display the collection.

Keep your data current with collection events

You can use the Collections API to keep up with collection changes by Wix users.

1. Listen for the Collection Created, Collection Updated, and Collection Deleted events to detect changes made by Wix users.

2. Based on the event type, adjust your data to reflect the latest collections.