Get the list of projects

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

Gets the list of projects.

Request

GET https://toloka.yandex.com/api/v1/projects
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
status

string

Status of the project:

  • ACTIVE — Active.

  • ARCHIVED — Archived.

sort

string

Parameters to sort by:

  • id — The project identifier.

  • created — The date when the project was created, in UTC using ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].

  • public_name — The project name.

  • private_comment — A comment on the project.

To learn how to configure sorting, see Sorting the list of objects.

owner

string

Requester ID.

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

string

Status of the project:

  • ACTIVE — Active.

  • ARCHIVED — Archived.

sort

string

Parameters to sort by:

  • id — The project identifier.

  • created — The date when the project was created, in UTC using ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].

  • public_name — The project name.

  • private_comment — A comment on the project.

To learn how to configure sorting, see Sorting the list of objects.

owner

string

Requester 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 projects in parts (for example, 10 projects at a time):

  1. Show the first 10 projects, starting with the project with the lowest ID.
  2. Show the remaining projects (10 at a time) in ascending order.
Show the first 10 projects
GET https://toloka.yandex.com/api/v1/projects?sort=id&limit=10
Authorization: OAuth <OAuth token>
Show the remaining tasks sorted by ascending ID
GET https://toloka.yandex.com/api/v1/projects?sort=id&limit=10&id_gt=<ID of the last project from the previous response>
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}