queryLabels( )

Creates a query to retrieve a list of labels.

The queryLabels() function builds a query to retrieve a list of labels and returns a LabelsQueryBuilder 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 LabelsQueryBuilder functions onto the query. LabelsQueryBuilder functions enable you to control the results queryLabels() returns.

queryLabels() runs with these LabelsQueryBuilder defaults, which you can override:

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

For property support for filters and sorting, see Query labels: Supported filters and sorting.

Method Declaration
This method does not take any parameters
Was this helpful?