API ReferenceTasks

Get task list

Retrieve a list of tasks.

You can use the query parameters to filter the list by project and/or view (a tab within the Data Manager). You can also optionally add pagination to make the response easier to parse.

The project ID can be found in the URL when viewing the project in Label Studio, or you can retrieve all project IDs using List all projects. The view ID can be found using List views.

Headers

AuthorizationstringRequired

Header authentication of the form Token <token>

Query parameters

pageintegerOptional
A page number within the paginated result set.
page_sizeintegerOptional
Number of results to return per page.
viewintegerOptional
View ID
projectintegerOptional
Project ID
resolve_uribooleanOptional
Resolve task data URIs using Cloud Storage
fieldsenumOptionalDefaults to task_only
Set to "all" if you want to include annotations and predictions in the response
Allowed values:
reviewbooleanOptional
Get tasks for review
includestringOptional
Specify which fields to include in the response
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"]

Response

List of Tasks
taskslist of objects or null

List of tasks, each task contains predictions and annotations if fields query parameter is set to all

totalinteger or null
Total number of tasks
total_annotationsinteger or null
Total number of annotations
total_predictionsinteger or null
Total number of predictions