List tasks

Retrieve a paginated list of tasks. The response format varies based on the user’s role in the organization:

  • Admin/Owner: Full task details with all annotations, reviews, and metadata
  • Reviewer: Task details optimized for review workflow
  • Annotator: Task details filtered to show only user’s own annotations and assignments

Headers

AuthorizationstringRequired

Header authentication of the form Token <token>

Query parameters

fieldsenumOptional

Set to “all” if you want to include annotations and predictions in the response. Defaults to task_only

Allowed values:
includestringOptional
Specify which fields to include in the response
only_annotatedbooleanOptional
Filter to show only tasks that have annotations
pageintegerOptional
A page number within the paginated result set.
page_sizeintegerOptional
Number of results to return per page.
projectintegerOptional
Project ID
querystringOptional

Additional query to filter tasks. It must be JSON encoded string of dict containing one of the following parameters: {“filters”: …, “selectedItems”: …, “ordering”: …}. Check Data Manager > Create View > see data field for more details about filters, selectedItems and ordering.

filters: dict with “conjunction” string (“or” or “and”) and list of filters in “items” array. Each filter is a dictionary with keys: “filter”, “operator”, “type”, “value”. Read more about available filters Example: {“conjunction”: “or”, “items”: [{“filter”: “filter:tasks:completed_at”, “operator”: “greater”, “type”: “Datetime”, “value”: “2021-01-01T00:00:00.000Z”}]} selectedItems: dictionary with keys: “all”, “included”, “excluded”. If “all” is false, “included” must be used. If “all” is true, “excluded” must be used. Examples: {“all”: false, “included”: [1, 2, 3]} or {“all”: true, “excluded”: [4, 5]} ordering: list of fields to order by. Currently, ordering is supported by only one parameter. Example: [“completed_at”]

resolve_uribooleanOptional
Resolve task data URIs using Cloud Storage
reviewbooleanOptional
Get tasks for review
selectedItemsstringOptional
JSON string of selected task IDs for review workflow
viewintegerOptional
View ID

Response

taskslist of objects
totalinteger
Total number of tasks
total_annotationsinteger
Total number of annotations
total_predictionsinteger
Total number of predictions

Errors