Get the list of projects

To get the list of created projects (including archived projects), send a GET request to the /projects resource.

Request

GET /api/v1/projects ?
  [status=<project status>]
& [limit=<maximum number of results in the response>]
& [sort=<fields to sort by>]
& [id_gt=<project ID>]
& [id_gte=<project ID>]
& [id_lt=<project ID>]
& [id_lte=<project ID>]
& [created_gt=<date>]
& [created_gte=<date>]
& [created_lt=<date>]
& [created_lte=<date>]

Host: https://sandbox.toloka.yandex.ru
Authorization: OAuth <OAuth token>
Request parameters

Parameter

Description

Data type

Required

status

Status of the project:

  • ACTIVE

  • ARCHIVED

String

No

limit

Limit on the number of results to return. By default — 20; maximum — 300.

Number

No

sort

Parameters to sort by:

  • id — Project ID number (ascending).

  • created — Project creation date in UTC in the format YYYY-MM-DD (ascending).

  • public_name — Project name (in alphabetical order).

  • private_comment — Comments on the project (in alphabetical order).

You can set multiple comma-separated parameters.

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

String

No

id_gt

Projects with an ID greater than the specified value.

String

No

id_gte

Projects with an ID greater than or equal to the specified value.

String

No

id_lt

Projects with an ID less than the specified value.

String

No

id_lte

Projects with an ID less than or equal to the specified value.

String

No

created_gt

Projects created after the specified date. The date is specified in UTC in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].

String

No

created_gte

Projects created after or on the specified date. The date is specified in UTC in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].

String

No

created_lt

Projects created before the specified date. The date is specified in UTC in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].

String

No

created_lte

Projects created before or on the specified date. The date is specified in UTC in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].

String

No

To get the list of projects in parts (for example, 10 projects at a time), use a combination of parameters in requests:

GET /api/v1/projects ?sort=id&limit=10
Host: https://sandbox.toloka.yandex.ru
Authorization: OAuth <OAuth token>
GET /api/v1/projects ?sort=id&limit=10&id_gt=<last project ID from the previous request>
Host: https://sandbox.toloka.yandex.ru
Authorization: OAuth <OAuth token>

Response

Contains a list of projects and their properties in the items array:

{"items": [{properties of project 1}, {properties of project 2}, ... {properties of project n}], "has_more": false}

Key

Value

Data type

has_more

Whether the list is complete:

  • true — There are more items that aren't included in the output (that are filtered out or restricted by the limit field).

  • false — The output lists all the items.

Boolean