#Поля задачи

GET /v1/tasks/fields

Возвращает схему полей задачи: типы, флаги «только чтение», статические перечисления значений для status и priority.

#Примеры

#curl — личный ключ

Terminal
curl "https://vibecode.bitrix24.tech/v1/tasks/fields" \
  -H "X-Api-Key: YOUR_API_KEY"

#curl — OAuth-приложение

Terminal
curl "https://vibecode.bitrix24.tech/v1/tasks/fields" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

#JavaScript — личный ключ

javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/tasks/fields', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Полей:', Object.keys(data.fields).length)
console.log('Значения status:', data.fields.status.enum)

#JavaScript — OAuth-приложение

javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/tasks/fields', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data } = await res.json()

#Поля ответа

Ниже — основные поля, описанные в API. В ответе также возвращаются их UPPER_SNAKE_CASE-эквиваленты Битрикс24 (TITLE, RESPONSIBLE_ID, CREATED_DATE и др.) — оставлены ради обратной совместимости.

Поле Bitrix24 Тип RO Описание
id ID number да Идентификатор задачи
title TITLE string Название задачи
description DESCRIPTION string Описание (поддерживает BB-код)
responsibleId RESPONSIBLE_ID number Ответственный. Список: GET /v1/users
createdBy CREATED_BY number да Постановщик. Список: GET /v1/users
status STATUS number Статус задачи. Допустимые значения в fields.status.enum
priority PRIORITY number Приоритет задачи. Допустимые значения в fields.priority.enum
groupId GROUP_ID number Рабочая группа. Список: GET /v1/workgroups
parentId PARENT_ID number Родительская задача. Список: GET /v1/tasks
deadline DEADLINE datetime Крайний срок (ISO 8601)
startDatePlan START_DATE_PLAN datetime Плановая дата начала
endDatePlan END_DATE_PLAN datetime Плановая дата окончания
timeEstimate TIME_ESTIMATE number Оценка трудозатрат в секундах
tags TAGS string Метки задачи
accomplices ACCOMPLICES array Соисполнители. Список: GET /v1/users
auditors AUDITORS array Наблюдатели. Список: GET /v1/users
closedDate CLOSED_DATE datetime да Дата закрытия (заполняется при переводе в статус 5 или 6)
createdDate CREATED_DATE datetime да Дата создания
changedDate CHANGED_DATE datetime да Дата последнего изменения

Расшифровка status — поле fields.status.enum:

Значение Метка Описание
1 New Начальное состояние. Новые задачи создаются со статусом 2; 1 встречается у задач, импортированных из внешних систем или мигрированных со старых версий портала
2 Pending Ждёт выполнения. Статус по умолчанию для новых задач
3 In Progress Выполняется
4 Awaiting Control Ожидает контроля. Исполнитель пометил задачу как сделанную, постановщик должен подтвердить
5 Completed Завершена
6 Deferred Отложена
7 Declined Отклонена

Расшифровка priority — поле fields.priority.enum:

Значение Метка
0 Низкий
1 Обычный
2 Высокий

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

Показаны основные поля. Полный ответ дополнительно содержит UPPER_SNAKE-эквиваленты и системные служебные поля.

JSON
{
  "success": true,
  "data": {
    "fields": {
      "id": { "type": "number", "readonly": true },
      "title": { "type": "string", "readonly": false },
      "description": { "type": "string", "readonly": false },
      "responsibleId": { "type": "number", "readonly": false },
      "createdBy": { "type": "number", "readonly": true },
      "status": {
        "type": "number",
        "readonly": false,
        "enum": [
          { "value": 1, "label": "New", "labelRu": "Новая" },
          { "value": 2, "label": "Pending", "labelRu": "Ждёт выполнения" },
          { "value": 3, "label": "In Progress", "labelRu": "Выполняется" },
          { "value": 4, "label": "Awaiting Control", "labelRu": "Ожидает контроля" },
          { "value": 5, "label": "Completed", "labelRu": "Завершена" },
          { "value": 6, "label": "Deferred", "labelRu": "Отложена" },
          { "value": 7, "label": "Declined", "labelRu": "Отклонена" }
        ]
      },
      "priority": {
        "type": "number",
        "readonly": false,
        "enum": [
          { "value": 0, "label": "Low", "labelRu": "Низкий" },
          { "value": 1, "label": "Normal", "labelRu": "Обычный" },
          { "value": 2, "label": "High", "labelRu": "Высокий" }
        ]
      },
      "deadline": { "type": "datetime", "readonly": false },
      "createdDate": { "type": "datetime", "readonly": true },
      "changedDate": { "type": "datetime", "readonly": true }
    }
  }
}

#Пример ответа при ошибке

403 — нет скоупа:

JSON
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'tasks' scope"
  }
}

#Ошибки

HTTP Код Описание
403 SCOPE_DENIED API-ключ не имеет скоупа tasks
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

Полный список общих ошибок API — Ошибки.

#Смотрите также