Получить список проектов

GET /projects

Получает список проектов.

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

cURL

Python

Nodejs

curl -X GET 'https://tasks.yandex.ru/api/v1/projects?status=ACTIVE&created_gte=2021-12-01' \
     -H 'Authorization: OAuth PlaceYourRealOAuthToken_Here'

import requests

url = "https://tasks.yandex.ru/api/v1/projects"
params = {
  'status': 'ACTIVE',
  'created_gte': '2021-12-01'
}
headers = {
  'Authorization': 'OAuth PlaceYourRealOAuthToken_Here'
}
response = requests.get(url, params=params, headers=headers)

print(response.text)

var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://tasks.yandex.ru/api/v1/projects',
  'qs': {'status': 'ACTIVE','created_gte': '2021-12-01'},
  'headers': {
    'Authorization': 'OAuth PlaceYourRealOAuthToken_Here'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

Заголовки

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

Query-параметры

Указываются в ссылке после знака вопроса, перечисляются через &.

Параметр	Описание
`status`	string Статус проекта: `ACTIVE` — активный; `ARCHIVED` — архивный.
`sort`	string Параметры для сортировки: `id` — идентификатор проекта; `created` — дата создания проекта по UTC в формате ISO 8601: `YYYY-MM-DDThh:mm:ss[.sss]`; `public_name` — название проекта; `private_comment` — комментарий к проекту. О том, как задать сортировку, читайте на странице Сортировка списка объектов.
`owner`	string Идентификатор заказчика.
`limit`	integer Ограничение на количество возвращаемых результатов. По умолчанию — 20, максимум — 300.
`id_gt`	string Объекты с идентификатором больше указанного значения.
`id_gte`	string Объекты с идентификатором больше или равным указанному значению.
`id_lt`	string Объекты с идентификатором меньше указанного значения.
`id_lte`	string Объекты с идентификатором меньше или равным указанному значению.
`created_gt`	string Объекты, выданные или созданные после указанной даты.
`created_gte`	string Объекты, выданные или созданные после указанной даты включительно.
`created_lt`	string Объекты, выданные или созданные до указанной даты.
`created_lte`	string Объекты, выданные или созданные до указанной даты включительно.

Больше примеров

Можно настроить показ перечня проектов частями (например, по 10 проектов):

Показать первые 10 проектов, начиная с проекта с наименьшим идентификатором.
Показывать оставшиеся проекты по 10 штук в порядке возрастания.

Показать первые 10 проектов

curl -X GET 'https://tasks.yandex.ru/api/v1/projects?sort=id&limit=10' \
     -H 'Authorization: OAuth PlaceYourRealOAuthToken_Here'

Показать остальные части с сортировкой по возрастанию идентификатора

curl -X GET 'https://tasks.yandex.ru/api/v1/projects?sort=id&limit=10&id_gt={ID_последнего_проекта_из_предыдущего_ответа}' \
     -H 'Authorization: OAuth PlaceYourRealOAuthToken_Here'

Ответ

Содержит список проектов и их свойства в массиве items:

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

Пример ответа

{
  "items": [
    {
      "id": "83859",
      "public_name": "Elephant color",
      "public_description": "What color is the elephant in the picture?",
      "public_instructions": "<p>Look at the picture and decide what color the elephant is.</p> You can zoom in or out using the buttons:</p> <img src=\"disc/img1.png>\"",
      "private_comment": "My first project",
      "task_spec": {
        "input_spec": {
          "image": {
            "type": "URL",
            "required": true,
            "hidden": false
          }
        },
        "output_spec": {
          "result": {
            "type": "string",
            "required": true,
            "hidden": false
          }
        },
        "view_spec": {
          "assets": {
            "script_urls": [
              "library1.js",
              "library2.js"
            ]
          },
          "markup": "<task interface code>",
          "script": "<JavaScript code>",
          "styles": "<CSS code>",
          "settings": {
            "showSkip": true,
            "showTimer": true,
            "showTitle": true,
            "showSubmit": true,
            "showFullscreen": true,
            "showInstructions": true,
            "showFinish": true,
            "showMessage": true,
            "showReward": true
          }
        }
      },
      "assignments_issuing_type": "AUTOMATED",
      "assignments_automerge_enabled": false,
      "max_active_assignments_count": 15,
      "quality_control": {
        "configs": [
          {
            "collector_config": {
              "type": "SKIPPED_IN_ROW_ASSIGNMENTS"
            },
            "rules": [
              {
                "conditions": [
                  {
                    "key": "skipped_in_row_count",
                    "operator": "GTE",
                    "value": 10
                  }
                ],
                "action": {
                  "type": "REJECT_ALL_ASSIGNMENTS",
                  "parameters": {
                    "public_comment": "Skipped more than 10 task suites in a row"
                  }
                }
              }
            ]
          }
        ]
      },
      "localization_config": {
        "default_language": "EN"
      },
      "owner": {
        "id": "6c6e20dc86cca2ae787afcb2629de162",
        "myself": true
      },
      "status": "ACTIVE",
      "created": "2022-01-22T07:50:14.210"
    }
  ],
  "has_more": true
}

Параметр

Описание

items

array of objects

Массив со списком проектов и их свойств.

has_more

boolean

Показывает, является ли список элементов в ответе полным.

Возможные значения:

true — не все элементы вошли в ответ из-за ограничений в параметре limit.

Можно получить остальные результаты с помощью параметров с постфиксами _lt(e) и _gt(e).

См. подробнее о фильтрации запросов.
false — в ответе содержатся все имеющиеся элементы.

Была ли статья полезна?

Проекты

Создать проект