Get the list of task suites

Attention

The toloka.yandex.com domain will be disabled starting July 1, 2023. Please use the toloka.dev domain for API requests.

Gets the list of task suites in the pool.

Request

Tip

Try our new API reference: more parameter details, request/response examples, and code samples in various programming languages, including the Toloka-Kit usage samples.

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

Headers

TitleOverview
AuthorizationA token for account authorization. Add OAuth as a prefix.

Query parameters

Query parameters are specified in the link after the question mark and separated by &.

ParameterOverview
pool_idstring

ID of the pool to get task suites from.

You must specify either task_id or pool_id.
task_idstring

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.
overlapinteger

Suites with an overlap equal to the specified value.
Standard query parameterslimit, 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

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

Show the remaining tasks sorted by ascending ID

Production version
Sandbox
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>

Response

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

Contains task suite data.
has_more

boolean

Shows whether the list is complete.

Acceptable values:

  • true — Not all elements are included in the output due to restrictions in the limit parameter.

    You can get the rest of the results by using the _lt(e) and _gt(e) parameters.

    Learn more about standard query parameters.

  • false — The output contains all the items.

Contact support
Toloka API
OverviewAccessing the APIRate limiting
Quick start
Reference
Project
Pools
Training
Subscriptions to events
Toloker selection
Ways to upload tasks
Tasks
Task suites
Tracking operations
Getting responses
Checking completed tasks
Bonuses
Messages for Tolokers
Various parameters
Libraries