queryExtendedFields( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Creates a query to retrieve a list of extended fields.

The queryExtendedFields() method builds a query to retrieve a list of extended fields and returns an FieldsQueryBuilder object.

The returned object contains the query definition, which is used to run the query using the find() method.

You can refine the query by chaining FieldsQueryBuilder methods onto the query. FieldsQueryBuilder methods enable you to filter, sort, and control the results that queryExtendedFields() returns.

queryExtendedFields() runs with these FieldsQueryBuilder defaults, which you can override:

  • skip()
  • limit(50)
  • descending('_createdDate')

The following FieldsQueryBuilder methods are supported for queryExtendedFields(). For a full description of the Extended Field object, see the object returned for the items property in FieldsQueryResult.

PROPERTYSUPPORTED FILTERS & SORTING
namespaceeq(),ne()
keyeq(),ne(),in()
displayNameeq(),ne(),in(),startsWith(),ascending(),descending()
dataTypeeq(),ne()
fieldTypeeq()
_createdDateeq(),ne(),gt(),lt(),ge(),le(),ascending(),descending()
_updatedDateeq(),ne(),gt(),lt(),ge(),le(),ascending(),descending()
Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Bookings Services and Settings
Manage Portfolio
Manage Members and Contacts - all permissions
Manage Contact Extended Fields
Manage Restaurants - all permissions
Learn more about app permissions.
Method Declaration
Copy
Request
This method does not take any parameters
Returns
Return Type:FieldsQueryBuilder
Errors
400Invalid Argument

There are 6 errors with this status code:

See the entire list and learn more about Wix errors.

Did this help?