POST

Query Collections


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 a list of collections given the provided paging, filtering, and sorting. Up to 100 collections can be returned per request.

The default sort is id in ASC.

For a detailed list of supported operations, see Collections: Supported Filters and Sorting. To learn how to query collections, see API Query Language.

Permissions
Manage Portfolio
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/portfolio/v1/collections/query

Body Params
queryQueryRequired

Query options.


includePageUrlboolean

Whether to include the collection's page URL and relative path in the response. Default: false

Response Object
collectionsArray <Collection>

List of collections.


metadataMetadata

Paging metadata.

Query Collections
Request
cURL
Response
JSON
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?