Получить сведения о бонусе

GET /user-bonuses/{id}

Получает свойства выданного бонуса, ID которого указан в запросе.

Можно получить идентификатор ({id}) из списка бонусов.

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

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

url = "https://tasks.yandex.ru/api/v1/user-bonuses/2939"
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/2939',
  'qs': {},
  'headers': {
    'Authorization': 'OAuth PlaceYourRealOAuthToken_Here'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

Path-параметры

Параметр

Описание

id*

string

Идентификатор выданного бонуса.

Заголовки

Заголовок

Описание

Authorization

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

Ответ

Сведения о бонусе.

Пример ответа
{
  "user_id": "21c4f092ebad180cf56b9babe0ef9f19",
  "amount": 5,
  "assignment_id": "6946cefa-32af-4f62-b530-8d2c71fa2966",
  "private_comment": "Good job!",
  "public_title": {
    "EN": "Completed tasks"
  },
  "public_message": {
    "EN": "10 tasks successfully completed"
  },
  "without_message": false,
  "id": "2092",
  "created": "2021-02-12T10:37:36.631"
}

Параметр

Описание

user_id

string

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

amount

float

Сумма бонуса в рублях.

assignment_id

string

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

private_comment

string

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

public_title

object

Заголовок сообщения для исполнителя. Может быть на нескольких языках (сообщение придет на языке исполнителя).

Формат: "<язык RU/EN/TR/ID/FR>": "<текст заголовка>".

Пример:

{
  "EN": "Title in English",
  "RU": "Заголовок на русском"
}

public_message

object

Текст сообщения для исполнителя. Может быть текст на нескольких языках (сообщение придет на языке исполнителя).

Формат: "<язык RU/EN/TR/ID/FR>": "<текст сообщения>".

Пример:

{
  "EN": "Message text in English",
  "RU": "Текст сообщения на русском"
}

without_message

boolean

Позволяет не отправлять исполнителю сообщение о бонусе. По умолчанию false.

Для того чтобы выдать бонус без сообщения, нужно указать null для public_title и public_message и true для without_message.

id

string

Идентификатор бонуса.

created

string

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

Обязательный параметр