About the Project Items API

Developer Preview
APIs in Developer Preview are subject to change and are not intended for use in production.
Send us your suggestions for improving this API. Your feedback is valuable to us.

 

The Project Items API allows you to manage a project's items. Learn more about project items in Wix Portfolio.

With the Project Items API, you can:

  • Create, update, and delete project items.
  • Retrieve project items.
  • Duplicate project items from one project to another project.
  • Listen for events when a project item is created, updated, or deleted.

Before you begin

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

  • You need an existing project to create project items. If you don't already have one, call Create Project to create a project, and then call Create Project Item to create a project item.
  • Project items consist of images or videos. Before you create or update a project item with a new media file, upload the media file to the Wix Media Manager by calling the Import File method.
  • You can only use this API on sites where a Wix user has installed the Wix Portfolio app.

Use case

Did this help?

Sample Use Case and Flow

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.

Create a digital photo frame

You can display a live photo gallery on a digital photo frame, updating dynamically in real-time.

  1. Call Create Project to create a project that will act as the photo gallery, allowing you to store and manage photos represented as project items within the gallery.

  2. Share the newly created project's ID with those who need to access the gallery so they can add or remove photos from the digital photo frame.

  3. Listen for Project Item Created, Project Item Updated, and Project Item Deleted events to detect when new photos are added, existing photos are updated, or photos are removed from the gallery.

  4. Periodically call List Project Items to retrieve the latest gallery content and ensure the photo frame reflects real-time changes.

Did this help?

Project Item Object

Properties
projectIdstringformat GUID

Project ID.

idstringRead-onlyformat GUID

Project item ID.

sortOrdernumberformat double

Index that determines which position a project is displayed in the project.

Default: Epoch timestamp.

titlestring

Project item title.

descriptionstring

Project item description.

typestringRead-only

Project item data type.

createdDatestringRead-onlyformat date-time

Date and time the project item was created.

updatedDatestringRead-onlyformat date-time

Date and time the project item was last updated.

linkLink

Project item link.

One Of
Choose one of the following parameters
imageImage

Information about the Wix Media image.

videoVideo

Information about the Wix Media video.

Item
JSON
{
  "projectId": "123e4567-e89b-12d3-a456-426614174000",
  "id": "987e6543-e21a-10d2-b987-426614176789",
  "sortOrder": 1694090400.0,
  "title": "Sample Project Item Title",
  "description": "This is a description for the sample project item.",
  "type": "IMAGE",
  "image": {
    "imageInfo": {
      "id": "987e6543-e21a-10d2-b987-426614176789",
      "url": "https://example.com/image.jpg",
      "width": 1920,
      "height": 1080
    }
  },
  "createdDate": "2024-07-31T12:00:00Z",
  "updatedDate": "2024-07-31T12:00:00Z",
  "link": {
    "text": "View Project",
    "url": "https://example.com/project",
    "target": "_blank"
  }
}
Did this help?