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

Получить список выданных бонусов

Важно

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

Получает список выданных бонусов.

Запрос

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

Заголовки

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

Query-параметры

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

Параметр

Описание

user_id

string

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

assignment_id

string

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

private_comment

string

Комментарий, доступный только заказчику.

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 бонусов):

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

Показать первые 10 бонусов

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

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

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

Ответ

Сведения о бонусах в массиве items:

{"items" : [{bonus #1}, {bonus #2}, ... {bonus #n}], "has_more": true}