Get the list of task suites

To get the list of task suites in a pool, send a GET request to the /task-suites resource.

Request

GET /api/v1/task-suites ?
  pool_id=<pool ID>
& [task_id=<task ID>]
& [limit=<maximum number of results in the response>]
& [sort=<fields to sort by>]
& [id_gt=<task suite ID>]
& [id_gte=<task suite ID>]
& [id_lt=<task suite ID>]
& [id_lte=<task suite ID>]
& [created_gt=<date>]
& [created_gte=<date>]
& [created_lt=<date>]
& [created_lte=<date>]
& [overlap=<overlap>]
& [overlap_gt=<overlap>]
& [overlap_gte=<overlap>]
& [overlap_lt=<overlap>]
& [overlap_lte=<overlap>]  

Host: https://sandbox.toloka.yandex.ru
Authorization: OAuth <OAuth token>
Request parameters

Parameter

Description

Data type

Required

pool_id

ID of the pool to get task suites from.

String

You must specify either task_id or pool_id.

task_id

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

String

You must specify either task_id or pool_id.

limit

Limit on the number of results to return. By default — 50; maximum — 100000.

Number

No

sort

Parameters for sorting in ascending order:

  • id — The ID of a task suite.

  • created — The date the task suite was created, in UTC in the format YYYY-MM-DD.

You can separate parameters with a comma.

To change the sorting direction to descending, add the minus sign before the parameter. For example, sort=-id.

String

No

id_gt

Task suites with an ID greater than the specified value.

String

No

id_gte

Task suites with an ID greater than or equal to the specified value.

String

No

id_lt

Task suites with an ID less than the specified value.

String

No

id_lte

Task suites with an ID less than or equal to the specified value.

String

No

created_gt

Task suites created after the specified date. The date is specified in UTC in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].

String

No

created_gte

Task suites created after or on the specified date. The date is specified in UTC in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].

String

No

created_lt

Task suites created before the specified date. The date is specified in UTC in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].

String

No

created_lte

Task suites created before or on the specified date. The date is specified in UTC in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].

String

No

overlap Suites with an overlap equal to the specified value. Number No
overlap_gt

Suites with an overlap greater than the specified value.

Number

No

overlap_gte

Suites with an overlap greater than or equal to the specified value.

Number

No

overlap_lt

Suites with an overlap less than the specified value.

Number

No

overlap_lte

Suites with an overlap less than or equal to the specified value.

Number

No

To get the list of task suites in parts (for example, 10 task suites at a time), use a combination of parameters in requests:

GET /api/v1/task-suites?sort=id&limit=10
Host: https://sandbox.toloka.yandex.ru
Authorization: OAuth <OAuth token>
GET /api/v1/task-suites?sort=id&limit=10&id_gt=<last task suite ID from the previous request>
Host: https://sandbox.toloka.yandex.ru
Authorization: OAuth <OAuth token>

Response

Contains task suites in the items array.

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