queryExtendedFields( )


Creates a query to retrieve a list of extended fields.

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

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

You can refine the query by chaining ExtendedFieldsQueryBuilder functions onto the query. ExtendedFieldsQueryBuilder functions enable you to control the results queryExtendedFields() returns.

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

Note: Only visitors with Manage Contacts permissions can query extended fields. You can override the permissions by setting the suppressAuth option to true in the find() function.

Supported Query Filters

The following ExtendedFieldsQueryBuilder filters are supported for queryExtendedFields().

For a full description of the ExtendedField object, see ExtendedFieldsQueryResult items.

PropertySupported Sorting                                                            
_createdDateascending(), descending()
_updatedDateascending(), descending()
displayNameascending(), descending()
Method Declaration
Copy
Request
This method does not take any parameters
Returns
Was this helpful?
Yes
No