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

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

Важно

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

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

Запрос

GET https://toloka.dev/api/v1/user-restrictions
Authorization: OAuth <OAuth token>
GET https://sandbox.toloka.dev/api/v1/user-restrictions
Authorization: OAuth <OAuth token>

Заголовки

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

Query-параметры

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

Параметр

Описание

scope

string

Область блокировки:

  • ALL_PROJECTS — все проекты заказчика;
  • PROJECT — проект (указывается project_id);
  • POOL — пул (указывается pool_id);
  • SYSTEM — исполнители, которые выполняли задания заказчика, но были заблокированы на платформе.

user_id

string

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

project_id

string | обязательный при условии

Обязателен, если scope=PROJECT.

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

pool_id

string | обязательный при условии

Обязателен, если scope=POOL.

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

sort

string

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

  • id — идентификатор;
  • created — дата создания по UTC в формате 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 — объекты, выданные или созданные до указанной даты включительно)

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

Чтобы получить список блокировок частями (например, по 10 блокировок), используйте комбинацию параметров в запросах:

GET https://toloka.dev/api/v1/user-restrictions?sort=id&limit=10
Authorization: OAuth <OAuth token>
GET https://toloka.dev/api/v1/user-restrictions?sort=id&limit=10&id_gt=<id last ban from the answer to the previous query>
Authorization: OAuth <OAuth token>
GET https://sandbox.toloka.dev/api/v1/user-restrictions?sort=id&limit=10
Authorization: OAuth <OAuth token>
GET https://sandbox.toloka.dev/api/v1/user-restrictions?sort=id&limit=10&id_gt=<id last ban from the answer to the previous query>
Authorization: OAuth <OAuth token>

Ответ

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

{"items" : [{ban parameters 1}, {ban parameters 2}, ... {ban parameters n}], "has_more": true}