Wix Portfolio Collections

This article explains the fixed permissions and field structure for the following Wix Portfolio collections:

Note: These collections are system collections, so you can't change their permissions in the CMS.

Tip: Before continuing, make sure you've read Working with Wix App Collections.

Collections

This section explains the permissions and fields available in the Collections collection.

Note: This collection contains read-write fields. Some fields are read-only and managed by Wix, while others can be updated in code.

To use the Collections collection in code, refer to it as Portfolio/Collections.

This document describes the permissions and fields in your Collections collection.

Important: You can query up to 100 items from the Collections collection. Trying to query more than 100 items by raising the query limit will result in an error.

Permissions

The Collections collection has the following permissions:

  • read: ANYONE
  • create: ADMIN
  • update: ADMIN
  • remove: ADMIN

Fields

This section describes each field in this collection and its properties.

Each field heading shows the field name followed by the field ID in parentheses, in the format "fieldName (fieldId)".

The fields are listed in the same order as the collection's default order in the CMS.

ID (_id)

Description: The collection ID that was created by the server. This is a system field and is hidden by default.

Type: Text

Can connect to data: Yes

Can use in dynamic page URL: Yes

Sortable: Yes

Filter Support: eq, ne, hasSome, startsWith

Read-only: Yes

Required: No

Revision (revision)

Description: The current state of an item in the collection. The revision's state changes every time an item is modified.

Type: Text

Can connect to data: Yes

Can use in dynamic page URL: No

Sortable: No

Filter Support: No

Read-only: Yes

Required: No

Title (title)

Description: The title of the collection.

Type: Text

Can connect to data: Yes

Can use in dynamic page URL: Yes

Sortable: Yes

Filter Support: eq, ne, hasSome, startsWith

Read-write: Yes

Required: No

Description (description)

Description: The description of the collection.

Type: Text

Can connect to data: Yes

Can use in dynamic page URL: Yes

Sortable: Yes

Filter Support: eq, ne, hasSome

Read-write: Yes

Required: No

Slug (slug)

Description: The collection item's slug. The slug is the URL-friendly name that is unique across the portfolio.

Type: Text

Can connect to data: Yes

Can use in dynamic page URL: Yes

Sortable: Yes

Filter Support: eq, ne, hasSome, startsWith

Read-write: Yes

Required: No

Cover Image (coverImage)

Description: A JSON object that represents the cover image of the collection.

Type: Object

Can connect to data: Yes, by the cover image's focal points.

Can use in dynamic page URL: No

Sortable: No

Filter Support: No

Read-write: Yes

Required: No

Copy

Hidden (hidden)

Description: Whether the collection is hidden.

Type: Boolean

Can connect to data: Yes

Can use in dynamic page URL: No

Sortable: No

Filter Support: eq, ne, hasSome

Read-write: Yes

Required: No

Sort Order (sortOrder)

Description: The collection sort order.

Type: Number

Can connect to data: Yes

Can use in dynamic page URL: Yes

Sortable: Yes

Filter Support: eq, ne, hasSome, lt, le, gt, ge

Read-write: Yes

Required: No

Created Date (_createdDate)

Description: The date the collection was created. This is a system field and is hidden by default.

Type: Date

Can connect to data: Yes

Can use in dynamic page URL: No

Sortable: Yes

Filter Support: eq, ne, hasSome, lt, gt

Read-only: Yes

Required: No

Updated Date (_updatedDate)

Description: The date the collection was last updated. This is a system field and is hidden by default.

Type: Date

Can connect to data: Yes

Can use in dynamic page URL: No

Sortable: Yes

Filter Support: eq, ne, hasSome, lt, gt

Read-only: Yes

Required: No

URL (url)

Description: The url of the collection page.

Type: Text

Can connect to data: Yes

Can use in dynamic page URL: No

Sortable: No

Filter Support: No

Read-only: Yes

Required: No

Seo Data (seoData)

Description: A JSON object that represents SEO data of the collection.

Type: Object

Can connect to data: No

Can use in dynamic page URL: No

Sortable: No

Filter Support: No

Read-write: Yes

Required: No

Copy

ProjectItems

This section explains the permissions and fields available in the ProjectItems collection.

Note: This collection contains read-write fields. Some fields are read-only and managed by Wix, while others can be updated in code.

To use the ProjectItems collection in code, refer to it as Portfolio/ProjectItems.

This document describes the permissions and fields in your ProjectItems collection.

Important: You can query up to 100 items from the Project Items collection. Trying to query more than 100 items by raising the query limit will result in an error.

Permissions

The Project Items collection has the following permissions:

  • read: ANYONE
  • create: ADMIN
  • update: ADMIN
  • remove: ADMIN

Fields

This section describes each field in this collection and its properties.

Each field heading shows the field name followed by the field ID in parentheses, in the format "fieldName (fieldId)".

The fields are listed in the same order as the collection's default order in the CMS.

Project (project)

Description: The project ID that contains the project item.

Type: Reference

Can connect to data: Yes, to the referenced item's field.

Can use in dynamic page URL: No

Sortable: No

Filter Support: eq

Read-write: Yes

Required: Yes

ID (_id)

Description: The project item ID that was created by the server. This is a system field and is hidden by default.

Type: Text

Can connect to data: Yes

Can use in dynamic page URL: No

Sortable: No

Filter Support: eq, hasSome

Read-only: Yes

Required: No

Sort Order (sortOrder)

Description: The project items sort order.

Type: Number

Can connect to data: Yes

Can use in dynamic page URL: No

Sortable: No

Filter Support: No

Read-write: Yes

Required: No

Title (title)

Description: The title of the project item.

Type: Text

Can connect to data: Yes

Can use in dynamic page URL: No

Sortable: No

Filter Support: No

Read-write: Yes

Required: No

Description (description)

Description: The description of the project item.

Type: Text

Can connect to data: No

Can use in dynamic page URL: No

Sortable: No

Filter Support: No

Read-write: Yes

Required: No

Type (type)

Description: The project item's type.

Type: Text

Can connect to data: No

Can use in dynamic page URL: No

Sortable: No

Filter Support: No

Read-only: Yes

Required: No

Note: The type field has one of the following values:

  • IMAGE
  • VIDEO

Created Date (_createdDate)

Description: The date the project item was created. This is a system field and is hidden by default.

Type: Date

Can connect to data: Yes

Can use in dynamic page URL: No

Sortable: No

Filter Support: No

Read-only: Yes

Required: No

Updated Date (_updatedDate)

Description: The date the project item was last updated. This is a system field and is hidden by default.

Type: Date

Can connect to data: Yes

Can use in dynamic page URL: No

Sortable: No

Filter Support: No

Read-only: Yes

Required: No

Image (image)

Description: A JSON object that represents a project item's image.

Type: Object

Can connect to data: Yes by the image's focal points.

Can use in dynamic page URL: No

Sortable: No

Filter Support: No

Read-write: Yes

Required: No

Copy

Video (video)

Description: A JSON object that represents a project item's video.

Type: Object

Can connect to data: No

Can use in dynamic page URL: No

Sortable: No

Filter Support: No

Read-write: Yes

Required: No

Note: Currently not supported in the Wix Editor.

Copy

Projects

This section explains the permissions and fields available in the Projects collection.

Note: This collection contains read-write fields. Some fields are read-only and managed by Wix, while others can be updated in code.

To use the Projects collection in code, refer to it as Portfolio/Projects.

This document describes the permissions and fields in your Projects collection.

Important: Trying to query more than 100 items exceeds the query limit and results in an error.

Permissions

The Projects collection has the following permissions:

  • read: ANYONE
  • create: ADMIN
  • update: ADMIN
  • remove: ADMIN

Fields

This section describes each field in this collection and its properties.

Each field heading shows the field name followed by the field ID in parentheses, in the format "fieldName (fieldId)".

The fields are listed in the same order as the collection's default order in the CMS.

ID (_id)

Description: The project ID created by the server. This is a system field and is hidden by default.

Type: Text

Can connect to data: Yes

Can use in dynamic page URL: Yes

Sortable: Yes

Filter Support: eq, ne, hasSome, startsWith

Read-only: Yes

Required: No

Revision (revision)

Description: The current state of a project in the collection.

Type: Text

Can connect to data: Yes

Can use in dynamic page URL: No

Sortable: No

Filter Support: No

Read-only: Yes

Required: No

Title (title)

Description: The title of the project.

Type: Text

Can connect to data: Yes

Can use in dynamic page URL: Yes

Sortable: Yes

Filter Support: eq, ne, hasSome, startsWith

Read-write: Yes

Required: No

Description (description)

Description: The description of the project.

Type: Text

Can connect to data: Yes

Can use in dynamic page URL: Yes

Sortable: Yes

Filter Support: eq, ne, hasSome, startsWith

Read-write: Yes

Required: No

Hidden (hidden)

Description: Whether the project is hidden.

Type: Boolean

Can connect to data: Yes

Can use in dynamic page URL: No

Sortable: No

Filter Support: eq, ne, hasSome

Read-write: Yes

Required: No

Collection IDs (collectionIds)

Description: Array of collection IDs that the project belongs to.

Type: Array of Strings

Can connect to data: Yes

Can use in dynamic page URL: No

Sortable: No

Filter Support: eq, ne, hasSome, hasAll

Read-write: Yes

Required: No

Details (details)

Description: The details of the project.

Type: Array of Objects

Can connect to data: No

Can use in dynamic page URL: No

Sortable: No

Filter Support: No

Read-write: Yes

Required: No

Copy

Slug (slug)

Description: The project's slug, which is its URL-friendly name that is unique across the portfolio.

Type: Text

Can connect to data: Yes

Can use in dynamic page URL: Yes

Sortable: Yes

Filter Support: eq, ne, hasSome, startsWith

Read-write: Yes

Required: No

Created Date (_createdDate)

Description: The date the project was created. This is a system field and is hidden by default.

Type: Date

Can connect to data: Yes

Can use in dynamic page URL: No

Sortable: Yes

Filter Support: eq, ne, hasSome, gt, lt

Read-only: Yes

Required: No

Updated Date (_updatedDate)

Description: The date the project was last updated. This is a system field and is hidden by default.

Type: Date

Can connect to data: Yes

Can use in dynamic page URL: No

Sortable: Yes

Filter Support: eq, ne, hasSome, gt, lt

Read-only: Yes

Required: No

URL (url)

Description: The url of the project page.

Type: URL

Can connect to data: Yes

Can use in dynamic page URL: No

Sortable: No

Filter Support: No

Read-only: Yes

Required: No

Seo Data (seoData)

Description: A JSON object that represents SEO data of the project.

Type: Object

Can connect to data: No

Can use in dynamic page URL: No

Sortable: No

Filter Support: No

Read-write: Yes

Required: No

Copy

Synced Project (syncedProject)

Description: Indicates whether the project is synced with an external platform.

Type: Boolean

Can connect to data: Yes

Can use in dynamic page URL: No

Sortable: No

Filter Support: No

Read-only: Yes

Required: No

Note: Synced projects are updated from their external platform on a daily basis.

Cover Image (coverImage)

Description: A JSON object that represents a project's cover image.

Type: Object

Can connect to data: Yes, by the cover image's focal points.

Can use in dynamic page URL: No

Sortable: No

Filter Support: No

Read-write: Yes

Required: No

Copy

Cover Video (coverVideo)

Description: A JSON object that represents a project's cover video.

Type: Object

Can connect to data: Yes

Can use in dynamic page URL: No

Sortable: No

Filter Support: No

Read-write: Yes

Required: No

Note: Currently not supported in the Wix Editor.

Copy
Did this help?