POST

Query Attribute Definitions


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

Query Attribute Definitions 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, name, valueType, visibility, tags.publicTags.tagIds, tags.privateTags.tagIds.

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
name$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteSort: ASC, DESC
valueType$eq, $ne, $exists, $in, $hasSomeSort: ASC, DESC
visibility$eq, $ne, $exists, $in, $hasSomeSort: ASC, DESC
tags.publicTags.tagIds$eq, $ne, $exists, $in, $hasSome, $hasAllSort: ASC, DESC
tags.privateTags.tagIds$eq, $ne, $exists, $in, $hasSome, $hasAllSort: ASC, DESC
Endpoint
POST
https://www.wixapis.com/_api/attributes/v1/attribute-definitions/query

Errors

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

Did this help?