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

GET /user-bonuses

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

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

curl -X GET 'https://tasks.yandex.ru/api/v1/user-bonuses' \
     -H 'Authorization: OAuth PlaceYourRealOAuthToken_Here'

import requests

url = "https://tasks.yandex.ru/api/v1/user-bonuses"
headers = {
  'Authorization': 'OAuth PlaceYourRealOAuthToken_Here'
}
response = requests.get(url, headers=headers)

print(response.text)

var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://tasks.yandex.ru/api/v1/user-bonuses',
  'qs': {},
  'headers': {
    'Authorization': 'OAuth PlaceYourRealOAuthToken_Here'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

Заголовки

Заголовок

Описание

Authorization

API-токен для авторизации аккаунта. В качестве префикса добавьте OAuth.

Query-параметры

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

Параметр

Описание

user_id

string

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

assignment_id

string

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

sort

string

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

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

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

limit

integer

Ограничение на количество возвращаемых результатов. По умолчанию — 20, максимум — 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 бонусов

curl -X GET 'https://tasks.yandex.ru/api/v1/user-bonuses?sort=id&limit=10' \
     -H 'Authorization: OAuth PlaceYourRealOAuthToken_Here'

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

curl -X GET 'https://tasks.yandex.ru/api/v1/user-bonuses?sort=id&limit=10&id_gt={ID_последнего_бонуса_из_предыдущего_ответа}' \
     -H 'Authorization: OAuth PlaceYourRealOAuthToken_Here'

Ответ

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

{
  "items": [
    {bonus #1},
    {bonus #2},
    ...
    {bonus #n}
  ],
  "has_more": true
}
Пример ответа
{
  "items": [
    {
      "user_id": "a1b0b42923c429daa2c764d7ccfc364d",
      "amount": 5,
      "private_comment": "Good job!",
      "public_title": {
        "EN": "Perfect job!"
      },
      "public_message": {
        "EN": "You are the best!"
      },
      "without_message": false,
      "assignment_id": "000015fccc--63bfc4c358d7a46c32a7b233",
      "id": "3139",
      "created": "2023-01-12T13:45:36.767"
    }
  ],
  "has_more": true
}

Параметр

Описание

items

array of objects

Массив со списком бонусов и их свойств.

has_more

boolean

Показывает, является ли список элементов в ответе полным.

Возможные значения:

  • true — не все элементы вошли в ответ из-за ограничений в параметре limit.

    Можно получить остальные результаты с помощью параметров с постфиксами _lt(e) и _gt(e).

    См. подробнее о фильтрации запросов.

  • false — в ответе содержатся все имеющиеся элементы.

Предыдущая
Бонусы
Следующая
Выдать бонусы