queryTasks( )


Creates a query to retrieve a list of tasks.

The queryTasks() function builds a query to retrieve a list of tasks and returns a TasksQueryBuilder object.

The returned object contains the query definition which is typically used to run the query using the find() function. You can refine the query by chaining TasksQueryBuilder functions onto the query. TasksQueryBuilder functions enable you to sort, filter, and control the results that queryTasks() returns.

queryTasks() runs with these TasksQueryBuilder defaults, which you can override:

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

The functions that are chained to queryTasks() are applied in the order they are called. For example, if you apply ascending('_createdDate') and then descending('_updatedDate'), the results are sorted first by the created date and then, if there are multiple results with the same date, the items are sorted by the updated date.

The following TasksQueryBuilder functions are supported for queryTasks(). For a full description of the task object, see the object returned for the items property in TasksQueryResult.

PROPERTYSUPPORTED FILTERS & SORTING
_ideq(),ne(),in(),ascending(),descending()
_createdDateeq(),ne(),gt(),lt(),ge(),le(),ascending(),descending()
_updatedDateeq(),ne(),gt(),lt(),ge(),le(),ascending(),descending()
dueDateeq(),ne(),gt(),lt(),ge(),le(),ascending(),descending()
statuseq(),ne(),in()
contact.ideq(),ne(),in(),exists()
Admin Method

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Tasks
Manage Tasks
Learn more about permission scopes.
Method Declaration
Copy
Request
This method does not take any parameters
Returns
Return Type:TasksQueryBuilder
Was this helpful?
Yes
No