QueryTasks
Searches for Tasks that match specified filtering criteria and returns matching tasks in paginated form.
This method allows filtering tasks based on multiple criteria including:
- Parent task relationships
- Task status (with inclusive or exclusive filtering)
- Update time ranges
- Task view (manager or agent perspective)
- Task assignee
- Task type (via exact URL matches or prefix matching)
Results are returned in pages. When more results are available than can be returned in a single
response, a page_token is provided that can be used in subsequent requests to retrieve the next
set of results.
By default, this returns the latest task version for each matching task from the manager's perspective.
QueryTasksRequest
Request
This endpoint expects an object.
task_type
parent_task_id
If present matches Tasks with this parent Task ID.
This is mutually exclusive with all other query parameters, i.e., either provide parent Task ID, or
any of the remaining parameters, but not both.
page_token
If set, returns results starting from the given page token.
status_filter
Filters on provided status types in the filter.
update_time_range
If provided, only provides Tasks updated within the time range.
view
The filter for view of a Task.
If not set, defaults to TASK_VIEW_MANAGER.
Allowed values:
assignee
If provided, returns Tasks that match this assignee.
QueryTasksResponse
Response
This endpoint returns an object.
tasks
Tasks matching the Query Task request.
page_token
Page token to the next page of Tasks.