Get a list of rewards issued

  1. Request
  2. Headers
  3. Query parameters
  4. Query example
  5. Response

Gets a list of rewards issued.

Request

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

Headers

Title Overview
authorization A token for account authorization. Add OAuth as a prefix.
Title Overview
authorization A token for account authorization. Add OAuth as a prefix.

Query parameters

Specified in the link after the question mark; separated by &.

Parameter Overview
user_id

string

User ID.

assignment_id

string

ID of the performer's response to the task a reward is issued for.

private_comment

string

Comments that are only visible to the requester.

sort

string

Parameters for sorting in ascending order:

  • id — Reward ID.
  • created — Date the reward was issued, in UTC in the format YYYY-MM-DD.

You can separate parameters with a comma.

To change the sorting direction to descending, add the minus sign before the parameter. For example, sort=-id.

Standard query parameters limit, id_gt, id_gte, id_lt, id_lte, created_gt, created_gte, created_lt, created_lte
Parameter Overview
user_id

string

User ID.

assignment_id

string

ID of the performer's response to the task a reward is issued for.

private_comment

string

Comments that are only visible to the requester.

sort

string

Parameters for sorting in ascending order:

  • id — Reward ID.
  • created — Date the reward was issued, in UTC in the format YYYY-MM-DD.

You can separate parameters with a comma.

To change the sorting direction to descending, add the minus sign before the parameter. For example, sort=-id.

Standard query parameters limit, id_gt, id_gte, id_lt, id_lte, created_gt, created_gte, created_lt, created_lte

Query example

You can set up the display of the list of rewards in parts (for example, 10 rewards at a time):
  1. Show the first 10 rewards, starting with the one with the lowest ID.
  2. Show the remaining rewards (10 at a time) in ascending order.
Show the first 10 responses
GET https://toloka.yandex.com/api/v1/user-bonuses?sort=id&limit=10
Authorization: OAuth <OAuth token>
Show the remaining responses sorted by ascending ID
GET https://toloka.yandex.com/api/v1/user-bonuses?sort=id&limit=10&id_gt=<ID of the last bonus from the previous response>
Authorization: OAuth <OAuth token>

Response

Information about rewards in the items array:

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