POST

Query Attribute Values


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 1000 attribute values, given the provided paging, filtering, and sorting.

Query Attribute Values runs with these defaults, which you can override:

  • createdDate is sorted in DESC order
  • paging.limit is 50
  • paging.offset is 0

Supported filter and sort fields: id, attributeDefinitionId, entityId, valueType, stringData, numberData, boolData.

Attribute values don't carry visibility; it's defined on the attribute definition. To respect visibility, resolve each value's definition (for example, with Query Attribute Definitions) and filter out non-visible attributes before displaying them publicly.

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
attributeDefinitionId$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteSort: ASC, DESC
entityId$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteSort: ASC, DESC
valueType$eq, $ne, $exists, $in, $hasSomeSort: ASC, DESC
stringData$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteSort: ASC, DESC
numberData$eq, $ne, $exists, $in, $hasSome, $lt, $lte, $gt, $gteSort: ASC, DESC
boolData$eq, $ne, $exists, $in, $hasSomeSort: ASC, DESC
Permissions
Manage_Wix_Attributes_Forms_submissions
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/_api/attributes/v1/attribute-values/query

Errors

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

Did this help?