Toloka documentation

Get a list of training pools

Gets the list of created training pools (including archived pools).

Request

GET https://toloka.yandex.com/api/v1/trainings
Authorization: OAuth <OAuth token>
GET https://sandbox.toloka.yandex.com/api/v1/trainings
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

status

string Training pool status:

  • OPEN — Open.
  • CLOSED — Closed.
  • LOCKED — No possible actions.
  • ARCHIVED — Archived.

project_id

string ID of the project that the training pool is linked to.

sort

string Parameters for sorting in ascending order:

  • id — ID of the training pool.
  • created — The date when the training pool was created, in UTC using ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].
  • last_started — The date when the training pool was last started, in UTC using ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].

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

Standard query parameters

limit, id_gt, id_gte, id_lt, id_lte, created_gt, created_gte, created_lt, created_lte, last_started_gt, last_started_gte, last_started_gte, last_started_lt, last_started_lte.

Query example

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

  1. Show the first 10 pools, starting with the pool with the lowest ID.
  2. Show the remaining pools (10 at a time) in ascending order.

Show the first 10 pools

GET https://toloka.yandex.com/api/v1/trainings?sort=id&limit=10
Authorization: OAuth <OAuth token>
GET https://sandbox.toloka.yandex.com/api/v1/trainings?sort=id&limit=10
Authorization: OAuth <OAuth token>

Show the remaining tasks sorted by ascending ID

GET https://toloka.yandex.com/api/v1/trainings?sort=id&limit=10&id_gt=<id of the last training from the previous response>
Authorization: OAuth <OAuth token>
GET https://sandbox.toloka.yandex.com/api/v1/trainings?sort=id&limit=10&id_gt=<id of the last training from the previous response>
Authorization: OAuth <OAuth token>

Response

Contains a list of training pools and their properties in the items array:

{"items" : [{parameters_of_training_pool_1}, {parameters_of_training_pool_2}, ... {parameters_of_training_pool__n_}], "has_more": false}