Toloka documentation

Get the list of task suites

Warning

We recommend that you use the toloka.dev domain for API requests. The toloka.yandex.com domain is still supported but it will be deprecated soon.

Gets the list of task suites in the pool.

Request

GET https://toloka.dev/api/v1/task-suites
Authorization: OAuth <OAuth token>
GET https://sandbox.toloka.dev/api/v1/task-suites
Authorization: OAuth <OAuth token>

Headers

Title Overview
Authorization A token for account authorization. Add OAuth as a prefix.

Query parameters

Specified in the link after the question mark; separated by &.

Parameter

Overview

pool_id

string

ID of the pool to get task suites from.

You must specify either task_id or pool_id.

task_id

string

The task ID in the suites that were generated automatically using "smart mixing". You will get task suites that contain the specified task.

You must specify either task_id or pool_id.

sort

string

Parameters to sort by:

  • id — The ID of a task suite.
  • created — The task suite creation date in UTC using ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].

To learn how to configure sorting, see Sorting the list of objects.

overlap

integer

Suites with an overlap equal to the specified value.

Standard query parameters

limit, id_gt, id_gte, id_lt, id_lte, created_gt, created_gte, created_lt, created_lte, overlap_gt, overlap_gte overlap_lt, overlap_lte.

Query example

You can set up the display of the list of task suites in parts (for example, 10 task suites at a time):

  1. Show the first 10 task suites, starting from the one with the lowest ID.
  2. Show the remaining task suites (10 at a time) in ascending order.

Show the first 10 task suites

GET https://toloka.dev/api/v1/task-suites?sort=id&limit=10
Authorization: OAuth <OAuth token>
GET https://sandbox.toloka.dev/api/v1/task-suites?sort=id&limit=10
Authorization: OAuth <OAuth token>

Show the remaining tasks sorted by ascending ID

GET https://toloka.dev/api/v1/task-suites?sort=id&limit=10&id_gt=<id of the last task suite from the previous response>
Authorization: OAuth <OAuth token>
GET https://sandbox.toloka.dev/api/v1/task-suites?sort=id&limit=10&id_gt=<id of the last task suite from the previous response>
Authorization: OAuth <OAuth token>

Response

Contains task suite data in the items array.

{"items" : [{task suite 1}, {task suite 2}, ... {task suite n}], "has_more": true}