Toloka documentation

Get the list of pools

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 a list of created pools (including archived pools).

Request

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

Status of the pool:

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

project_id

string ID of the project to which the pool is attached.

sort

string

Parameters to sort by:

  • id — Pool ID.
  • created — The date when the pool was created, in UTC using ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].
  • last_started — The date when the 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_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.dev/api/v1/pools?sort=id&limit=10
Authorization: OAuth <OAuth token>
GET https://sandbox.toloka.dev/api/v1/pools?sort=id&limit=10
Authorization: OAuth <OAuth token>

Show the remaining tasks sorted by ascending ID

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

Response

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

{"items": [{parameters_of_pool_1}, {parameters_of_pool_2}, ... {parameters_of_pool__n_}], "has_more": false}