Sign in
Tasks

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
get/api/tasks/

Query parameters

fields'all' | 'task_only'

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

includestring

Specify which fields to include in the response

only_annotatedboolean

Filter to show only tasks that have annotations

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

projectinteger

Project ID

querystring

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_uriboolean

Resolve task data URIs using Cloud Storage

reviewboolean

Get tasks for review

selectedItemsstring

JSON string of selected task IDs for review workflow

viewinteger

View ID

Response

totalinteger required

Total number of tasks

total_annotationsinteger required

Total number of annotations

total_predictionsinteger required

Total number of predictions

Example response

{
  "total": 123,
  "total_annotations": 456,
  "total_predictions": 78
}

Changes

Changed in 4 of the 97 revisions of this API.19

  • b5f055b9d45b8See the full diff
    • ▲

      the response property tasks/items/oneOf[LseTaskSerializerForReviewers]/file_upload became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property tasks/items/oneOf[LseTaskSerializerForReviewers]/storage_filename became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property tasks/items/oneOf[LseTask]/file_upload became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property tasks/items/oneOf[LseTask]/storage_filename became nullable for the status 200

      response-property-became-nullable

    • ▲

      the tasks/items/oneOf[LseTaskSerializerForReviewers]/agreement response's property type/format changed from string/ to number/double for status 200

      response-property-type-changed

    • ▲

      the tasks/items/oneOf[LseTaskSerializerForReviewers]/agreement_selected response's property type/format changed from string/ to number/double for status 200

      response-property-type-changed

    • ▲

      the tasks/items/oneOf[LseTask]/agreement response's property type/format changed from string/ to number/double for status 200

      response-property-type-changed

    • ▲

      the tasks/items/oneOf[LseTask]/agreement_selected response's property type/format changed from string/ to number/double for status 200

      response-property-type-changed

  • fa73fba014805See the full diff
    • ▲

      the tasks/items/oneOf[LseTaskSerializerForAnnotators]/annotations response's property type/format changed from string/ to array/ for status 200

      response-property-type-changed

    • ▲

      the tasks/items/oneOf[LseTaskSerializerForAnnotators]/comment_count response's property type/format changed from string/ to integer/ for status 200

      response-property-type-changed

    • ▲

      the tasks/items/oneOf[LseTaskSerializerForAnnotators]/unresolved_comment_count response's property type/format changed from string/ to integer/ for status 200

      response-property-type-changed

    • ▲

      the tasks/items/oneOf[LseTaskSerializerForReviewers]/annotations response's property type/format changed from string/ to array/ for status 200

      response-property-type-changed

    • ▲

      the tasks/items/oneOf[LseTask]/annotations response's property type/format changed from string/ to array/ for status 200

      response-property-type-changed

  • fb0e19e02bb94See the full diff
    • ▲

      the response property tasks/items/oneOf[LseTaskSerializerForReviewers]/annotation_time became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property tasks/items/oneOf[LseTaskSerializerForReviewers]/review_time became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property tasks/items/oneOf[LseTask]/annotation_time became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property tasks/items/oneOf[LseTask]/review_time became nullable for the status 200

      response-property-became-nullable

  • 26d0743231722See the full diff
    • ▲

      the tasks/items/oneOf[LseTaskSerializerForReviewers]/annotators/items/ response's property type/format changed from integer/ to object/ for status 200

      response-property-type-changed

    • ▲

      the tasks/items/oneOf[LseTask]/annotators/items/ response's property type/format changed from integer/ to object/ for status 200

      response-property-type-changed

Of the 97 revisions, 1 has no diff computed.