Get the list of pools

Attention

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

Gets a list of created pools (including archived pools).

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/pools
Authorization: OAuth <OAuth token>

Headers

Title	Overview
Authorization	A 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 &.

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):

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

Show the first 10 pools

Production version

Sandbox

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

Response

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

Property Description

items[] array of objects

Contains a list of pools and their properties.

Property	Description
items[]	array of objects Contains a list of pools and their properties.
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.

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

Overview Accessing the API Rate limiting

Quick start

Reference

Project

Pools

Training

Subscriptions to events

Toloker selection

Ways to upload tasks

Tasks