Get responses

Attention

The toloka.yandex.com domain will be disabled starting April 1, 2023. Please use the toloka.dev domain for API requests.

Gets responses for all the pool's task suites.

Request

Production version

Sandbox

GET https://toloka.dev/api/v1/assignments
Authorization: OAuth <OAuth token>

Headers

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
status	string Status of an assigned task suite. If you need to list multiple statuses, separate them with commas: `ACTIVE` — Being completed by a Toloker. `SUBMITTED` — Completed but not checked. `ACCEPTED` — Accepted by the requester. `REJECTED` — Rejected by the requester. `SKIPPED` — Skipped by the Toloker. `EXPIRED` — The time for completing the tasks expired.
task_id	string You must specify either `task_id`,`pool_id`, or `task_suite_id`. The task ID in the suites that were generated automatically using "smart mixing". You will get responses for task suites that contain the specified task.
task_suite_id	string You must specify either `task_id`,`pool_id`, or `task_suite_id`. ID of a task suite.
pool_id	string You must specify either `task_id`,`pool_id`, or `task_suite_id`. Pool ID.
user_id	string Toloker ID.
sort	string Parameters to sort by: `id` — ID of the task suite assignment. `created` — The date the task suite was assigned. `submitted` — The date the task suite was completed. `skipped` — The date the task suite was skipped. `expired` — The date the task suite expired. `accepted` — The date the task suite was accepted by the requester. `rejected` — The date the task suite was rejected by the requester. Note All dates use the ISO 8601 format `YYYY-MM-DDThh:mm:ss[.sss]`. To learn how to configure sorting, see Sorting the list of objects.
Standard query parameters	limit, id_gt, id_gte, id_lt, id_lte, created_gt, created_gte, created_lt, created_lte, submit_gt, submit_gte, submit_lt, submit_lte, acceptedt_gt, accepted_gte, accepted_lt, accepted_lte, rejected_gt, rejected_gte, rejected_lt, rejected_lte, skipped_gt, skipped_gte, skipped_lt, skipped_lte, expired_gt, expired_gte, expired_lt, expired_lte.

Query example

You can set up the display of the list of responses in parts (for example, 10 responses at a time):

Show the first 10 responses, starting with the one with the lowest ID.
Show the remaining responses (10 at a time) in ascending order.

Show the first 10 responses

Production version

Sandbox

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

Show the remaining tasks sorted by ascending ID

Production version

Sandbox

GET https://toloka.dev/api/v1/assignments?sort=id&limit=10&id_gt=<ID of the last task suite from the previous response>
Authorization: OAuth <OAuth token>

Response

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

Property Description

items[] array of objects

Contains information about responses.

Property	Description
items[]	array of objects Contains information about responses.
has_more	boolean Shows whether the list is complete. Acceptable values: `true` — Not all elements are included in the output due to restrictions in the limit parameter. You can get the rest of the results by using the `_lt(e)` and `_gt(e)` parameters. Learn more about standard query parameters. `false` — The output contains all the items.

has_more

boolean

Shows whether the list is complete.

Acceptable values:

true — Not all elements are included in the output due to restrictions in the limit parameter.
You can get the rest of the results by using the _lt(e) and _gt(e) parameters.
Learn more about standard query parameters.
false — The output contains all the items.

Contact support

Toloka API

Overview Accessing the API Rate limiting

Quick start

Reference

Project

Pools

Training

Subscriptions to events

Toloker selection

Ways to upload tasks

Tasks