# About the Projects API

<div style="background-color: #FEF1D1; padding: 18px 24px; border-radius: 6px; border: 1px solid #FDB10C; box-sizing: border-box; display: inline-block">
    <b>Developer Preview</b>
    <br/>
    <span>APIs in <a href="fallback::https://www.wix.com/velo/reference/api-overview/developer-preview">Developer Preview</a> are subject to change and are not intended for use in production.<br/><a href="fallback::mailto:velo-preview-feedback@wix.com">Send us</a> your suggestions for improving this API. Your feedback is valuable to us.</span>
</div>

&nbsp;


The Projects API allows you to manage projects in a site's portfolio. Learn more about [projects in Wix Portfolio](fallback::https://support.wix.com/en/article/wix-portfolio-managing-your-wix-portfolio#managing-your-projects).


With the Projects API, you can:

+ Create, update, and delete projects. 
+ Retrieve, list, and query projects.
+ Listen for events when a project is created, updated, and deleted. 

## Before you begin

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

+ To add or update a cover image or video for projects, first upload the media file to the [Wix Media Manager](fallback::https://support.wix.com/en/article/wix-media-about-the-media-manager) by calling the [Import File](fallback::https://dev.wix.com/docs/rest/assets/media/media-manager/files/import-file) method.
+ You can only use this API on sites where a Wix user has installed the [Wix Portfolio app](fallback::https://www.wix.com/app-market/web-solution/wix-portfolio?appIndex=0&collimp_id=b54d3569-fdaa-49f6-83f8-2ac6e400bd11&referralSectionName=wix%20portfolio).

## Use cases

+ [Delete residential building projects older than 2 years](fallback::https://dev.wix.com/docs/rest/business-solutions/portfolio/projects/sample-flows#delete-residential-building-projects-older-than-2-years).
+ [Fetch project information for your art gallery](fallback::https://dev.wix.com/docs/rest/business-solutions/portfolio/projects/sample-flows#fetch-project-information-for-your-art-gallery).

# 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.

## Delete residential building projects older than 2 years
You can integrate with the Projects API to display residential building projects available for investment. To keep listings current, once a year you might want to delete projects that are over 2 years old.

1. Call [Create Projects](fallback::https://dev.wix.com/docs/rest/business-solutions/portfolio/projects/create-project) to create a project for each residential building available for investment. 

2. Once a year, call [Query Projects](fallback::https://dev.wix.com/docs/rest/business-solutions/portfolio/projects/query-projects) using the created date property to retrieve all projects in the site's portfolio older than 2 years. Record the returned project IDs. 

2. For each project ID returned, call [Delete Project](fallback::https://dev.wix.com/docs/rest/business-solutions/portfolio/projects/delete-project) to remove the project from the portfolio. 

## Fetch project information for your art gallery

You can create a curated art gallery that lists various artists' projects. To display the most up-to-date projects from your artists, set the gallery to automatically fetch and display projects whenever Wix users add, update, or delete them. 

1. Wix users can create and manage projects in a Wix Portfolio. 

2. Listen for the [Project Created](fallback::https://dev.wix.com/docs/rest/business-solutions/portfolio/projects/project-created), [Project Updated](fallback::https://dev.wix.com/docs/rest/business-solutions/portfolio/projects/project-updated), and [Project Deleted](fallback::https://dev.wix.com/docs/rest/business-solutions/portfolio/projects/project-deleted) events to detect when projects have been added, updated, or deleted. Retrieve the latest project data from the event object.

3. Reflect the changes in your gallery.

# Projects: Supported Filters and Sorting

This article covers field support for filtering and sorting in the Projects API.


The following table shows field support for filters and sorting for the projects object when calling [Query Projects](fallback::https://dev.wix.com/docs/rest/business-solutions/portfolio/projects/query-projects):


| Field                | Supported Filters                                                              | Sortable   |
| ---------------------| ------------------------------------------------------------------------------ | ---------- |
| `id`                 | `eq`, `ne`, `exists`, `in`, `hasSome`, `startsWith`, `ascending`, `descending` |  Sortable  |
| `title`              | `eq`, `ne`, `exists`, `in`, `hasSome`, `startsWith`, `ascending`, `descending` |  Sortable  |
| `description`        | `eq`, `ne`, `exists`, `in`, `hasSome`, `startsWith`, `ascending`, `descending` |  Sortable  |
| `slug`               | `eq`, `ne`, `exists`, `in`, `hasSome`, `startsWith`, `ascending`, `descending` |  Sortable  |
| `hidden`             | `eq`, `ne`, `exists`, `in`, `hasSome`, `startsWith`, `ascending`, `descending` |            |
| `collectionIds`      | `eq`, `ne`, `exists`, `in`, `hasSome`, `startsWith`, `ascending`, `descending` |            |
| `createdDate`        | `eq`, `ne`, `exists`, `in`, `hasSome`, `startsWith`, `ascending`, `descending` |  Sortable  |
| `updatedDate`        | `eq`, `ne`, `exists`, `in`, `hasSome`, `startsWith`, `ascending`, `descending` |  Sortable  |

Get Project