queryCustomFieldSuggestions( )

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 suggestions for both custom fields and existsting fields available from the Wix Members Area, given the provided paging, filtering, and sorting.

Query Custom Field Suggestions runs with these defaults, which you can override:

  • createdDate is sorted in ASC order
  • paging.limit is 100
  • paging.offset is 0

For field support for filters and sorting, see Supported Filters and Sorting. To learn about working with Query endpoints, see API Query Language, Sorting and Paging, and Field Projection.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Members and Contacts - all permissions
Read Members and Contacts - all read permissions
Manage Members
Read Members
Learn more about app permissions.
Method Declaration
Copy
function queryCustomFieldSuggestions(): SuggestionsQueryBuilder;
Request
This method does not take any parameters
Returns
Return Type:SuggestionsQueryBuilder
JavaScript
import { customFieldSuggestions } from "@wix/members";

async function queryCustomFieldSuggestions() {
  const { items } = await customFieldSuggestions
    .queryCustomFieldSuggestions()
    .find();
}
Errors

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

Did this help?