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

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

Важно

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

Получает список проектов.

Запрос

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

Заголовки

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

Query-параметры

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

Параметр

Описание

status

string

Статус проекта:

  • ACTIVE — активный;
  • ARCHIVED — архивный.

sort

string

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

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

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

owner

string

Идентификатор заказчика.

Стандартные 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 — объекты, выданные или созданные до указанной даты включительно)

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

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

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

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

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

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

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

Ответ

Содержит список проектов и их свойства в массиве items:

{"items": [{properties of project 1}, {properties of project 2}, ... {properties of project n}], "has_more": false}