POST

Query Component


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 50 components, given the provided paging, filtering, and sorting.

Query Component runs with these defaults, which you can override:

  • createdDate is sorted in DESC order
  • cursorPaging.limit is 50

The query must filter by appId. Supported fields for filtering and sorting are id, appId, version, externalId, and type.

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

PropertyFiltersSort
id$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteSort: ASC, DESC
appId$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteSort: ASC, DESC
version$eq, $ne, $exists, $in, $hasSome, $lt, $lte, $gt, $gteSort: ASC, DESC
externalId$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteSort: ASC, DESC
type$eq, $ne, $exists, $in, $hasSomeSort: ASC, DESC
Endpoint
POST
https://www.wixapis.com/apps/v1/components/v1/components/query

Errors

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

Did this help?