Документация Толоки

Получить список пулов

Важно

Домен toloka.yandex.com работает в режиме deprecated. Рекомендуем переключиться на домен toloka.dev для запросов API.

Получает список созданных пулов (в том числе архивных).

Запрос

GET https://toloka.dev/api/v1/pools
Authorization: OAuth <OAuth token>
GET https://sandbox.toloka.dev/api/v1/pools
Authorization: OAuth <OAuth token>

Заголовки

Заголовок Описание
Authorization Токен для авторизации аккаунта. В качестве префикса добавьте OAuth.

Query-параметры

Указываются в ссылке после знака вопроса, перечисляются через &.

Параметр

Описание

status

string

Статус пула:

  • OPEN — открыт;
  • CLOSED — закрыт;
  • LOCKED — заблокирован: невозможны никакие действия;
  • ARCHIVED — архивный.

project_id

string

Идентификатор проекта, к которому относится пул.

sort

string

Параметры для сортировки:

  • id — идентификатор пула;
  • created — дата создания пула по UTC в формате ISO 8601: YYYY-MM-DDThh:mm:ss[.sss];
  • last_started — дата последнего запуска пула в формате ISO 8601: YYYY-MM-DDThh:mm:ss[.sss].

О том, как задать сортировку, читайте на странице Сортировка списка объектов.

Стандартные query-параметры

  • limit (integer - ограничение на количество возвращаемых результатов. По умолчанию — 50, максимум — 300)
  • id_gt (string - объекты с идентификатором больше указанного значения)
  • id_gte (string - объекты с идентификатором больше или равным указанному значению)
  • id_lt (string - объекты с идентификатором меньше указанного значения)
  • id_lte (string - объекты с идентификатором меньше или равным указанному значению)
  • created_gt (string - объекты, выданные или созданные после указанной даты)
  • created_gte (string - объекты, выданные или созданные после указанной даты включительно)
  • created_lt (string - объекты, выданные или созданные до указанной даты)
  • created_lte (string - объекты, выданные или созданные до указанной даты включительно)
  • last_started_gt (string - объекты, которые были в последний раз открыты после указанной даты)
  • last_started_gte (string - объекты, которые были в последний раз открыты после указанной даты включительно)
  • last_started_lt (string - объекты, которые были в последний раз открыты до указанной даты)
  • last_started_lte (string - объекты, которые были в последний раз открыты раньше указанной даты включительно)

Пример запроса

Можно настроить показ списка пулов частями (например, по 10 пулов):

  1. Показать первые 10 пулов, начиная с пула с наименьшим идентификатором.
  2. Показывать оставшиеся пулы по 10 штук в порядке возрастания.

Показать первые 10 пулов

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>

Показывать остальные части с сортировкой по возрастанию идентификатора

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>

Ответ

Содержит список обычных пулов и их свойства в массиве items:

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