queryReferencedDataItems( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves the full items referenced in the specified field of an item.

Reference and multi-reference fields refer to items in different collections. Use this function to retrieve the full details of the referenced items themselves.

For example, suppose you have a Movies collection with an Actors field that contains references to items in a People collection. Querying the Movies collection using queryReferencedDataItems() returns the relevant People items referenced in the Actors field of the specified Movie item. This gives you information from the People collection about each of the actors in the specified movie.

Note: When calling queryReferencedDataItems() following an update to your collection, the data retrieved may not contain the most recent changes. If you need the most up-to-date data, set options.consistentRead to true.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Read Data Items
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
optionsQueryReferencedDataItemsOptions

Options for querying referenced data items.

Returns
Return Type:Promise<QueryReferencedDataItemsResponse>
Did this help?