POST

Query Premium Assets


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 up to 100 Premium assets, given the provided paging, filtering, and sorting.

Query Premium Assets runs with these defaults, which you can override:

  • cursorPaging.limit is 50

Pass the ID of the account whose assets you want to retrieve in the targetAccountId header. The call fails without it.

Which assets are returned depends on what the caller is permitted on. A caller permitted on the target account receives all of the account's assets. A caller permitted only on a specific site receives that site's assets alone, and the results are filtered to that site. In the second case the site is taken from the call scope, so a call with neither an account permission nor a site in scope fails.

Assets for which the account is Billing Manager aren't returned by default. Pass {"includePermitted": true} to include them. Sort isn't guaranteed to be applied when includePermitted is true.

Sorting applies to the first page of results. Following requests use the cursor token, which already carries the sort from the first call.

To learn about working with Query methods, see API Query Language, Sorting and Paging, and Field Projection.

Authentication

You can only call this method when authenticated as a Wix user or by using an account level API key.

Permission Scopes
Manage Premium Subscriptions
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/premium-assets/v2/premium-assets/query

Errors
400Invalid Argument

There are 2 errors with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?