Справочник методов

Все 29 операций публичного REST API v1. Справочник и скачиваемая спецификация используют один контракт.

Базовый URL: https://app.pmly.ru/api/public/v1. Все запросы требуют Authorization: Bearer <token>.

Скачать OpenAPI 3.1 · Общие правила и ошибки

Примеры иллюстрируют формат. Подставьте реальные ID в переменные окружения, текущую VERSION и новый IDEMPOTENCY_KEY для каждого создания. UUID, даты и текст в JSON — демонстрационные значения.

GET/contextСсылка

Получить контекст

Возвращает пользователя, пространство, выданные scopes и срок действия токена. Доступно с любым действующим токеном; используйте workspace.id для последующих запросов.

Разрешения: любой действующий токен. operationId: getContext

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

curl --request GET "$PMLY_API/context" \
  --header "Authorization: Bearer $PMLY_API_TOKEN"

Ответы

HTTP	Схема	Описание
`200`	`Context`	Успешный запрос Заголовки: X-Request-Id
`400`	`Error`	Неверные параметры или тело запроса
`401`	`Error`	Токен отсутствует, истёк или отозван Заголовки: WWW-Authenticate
`403`	`Error`	Недостаточно разрешений или бизнес-прав
`404`	`Error`	Ресурс не найден или недоступен в этом пространстве
`409`	`Error`	Конфликт версии или ключа идемпотентности
`413`	`Error`	Тело запроса слишком велико
`429`	`Error`	Лимит запросов; подождите Retry-After секунд Заголовки: Retry-After
`500`	`Error`	Internal error

Схема и пример ответа 200

Поле	Тип	Описание
`user` Обязательно	`object`	Пользователь, от имени которого действует токен.
`workspace` Обязательно	`Workspace`	Пространство токена и текущая роль пользователя.
`scopes` Обязательно	`array<string>`	Разрешения токена. Элементы: string
`expiresAt` Обязательно	`string`	Дата и время истечения токена. date-time

Дополнительные поля запрещены.

Вложенные поля user

Поле	Тип	Описание
`id` Обязательно	`string`	uuid
`displayName` Обязательно	`string \| null`

Дополнительные поля запрещены.

Демонстрационный ответ

{
  "user": {
    "id": "00000000-0000-4000-8000-000000000001",
    "displayName": "Пример"
  },
  "workspace": {
    "id": "00000000-0000-4000-8000-000000000001",
    "name": "Пример названия",
    "role": "OWNER"
  },
  "scopes": [
    "Пример"
  ],
  "expiresAt": "2026-09-30T10:00:00Z"
}

GET/workspaces/{workspaceId}Ссылка

Получить пространство

Возвращает имя пространства и роль текущего пользователя. Доступ ограничен пространством, к которому привязан токен.

Разрешения: workspace:read. operationId: getWorkspace

Параметры

Параметр	Где / тип	Описание
`workspaceId` Обязательно	path · `string`	UUID пространства, к которому привязан токен. uuid

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

curl --request GET "$PMLY_API/workspaces/$WORKSPACE_ID" \
  --header "Authorization: Bearer $PMLY_API_TOKEN"

Ответы

HTTP	Схема	Описание
`200`	`Workspace`	Успешный запрос Заголовки: X-Request-Id
`400`	`Error`	Неверные параметры или тело запроса
`401`	`Error`	Токен отсутствует, истёк или отозван Заголовки: WWW-Authenticate
`403`	`Error`	Недостаточно разрешений или бизнес-прав
`404`	`Error`	Ресурс не найден или недоступен в этом пространстве
`409`	`Error`	Конфликт версии или ключа идемпотентности
`413`	`Error`	Тело запроса слишком велико
`429`	`Error`	Лимит запросов; подождите Retry-After секунд Заголовки: Retry-After
`500`	`Error`	Internal error

Схема и пример ответа 200

Поле	Тип	Описание
`id` Обязательно	`string`	Постоянный UUID ресурса. uuid
`name` Обязательно	`string`	Название ресурса.
`role` Обязательно	`string`	Роль участника: OWNER или MEMBER. Значения: "OWNER", "MEMBER"

Дополнительные поля запрещены.

Демонстрационный ответ

{
  "id": "00000000-0000-4000-8000-000000000001",
  "name": "Пример названия",
  "role": "OWNER"
}

GET/workspaces/{workspaceId}/teamsСсылка

Список команд

Возвращает команды пространства с постоянными UUID и ключами. teamId нужен при создании задач, проектов и циклов.

Разрешения: workspace:read. operationId: listTeams

Параметры

Параметр	Где / тип	Описание
`workspaceId` Обязательно	path · `string`	UUID пространства, к которому привязан токен. uuid
`limit` Необязательно	query · `integer`	Размер страницы. По умолчанию: 50. Минимум: 1. Максимум: 100
`offset` Необязательно	query · `integer`	Количество пропущенных ресурсов. По умолчанию: 0. Минимум: 0. Максимум: 100000

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

curl --request GET "$PMLY_API/workspaces/$WORKSPACE_ID/teams" \
  --header "Authorization: Bearer $PMLY_API_TOKEN"

Ответы

HTTP	Схема	Описание
`200`	`TeamPage`	Успешный запрос Заголовки: X-Request-Id
`400`	`Error`	Неверные параметры или тело запроса
`401`	`Error`	Токен отсутствует, истёк или отозван Заголовки: WWW-Authenticate
`403`	`Error`	Недостаточно разрешений или бизнес-прав
`404`	`Error`	Ресурс не найден или недоступен в этом пространстве
`409`	`Error`	Конфликт версии или ключа идемпотентности
`413`	`Error`	Тело запроса слишком велико
`429`	`Error`	Лимит запросов; подождите Retry-After секунд Заголовки: Retry-After
`500`	`Error`	Internal error

Схема и пример ответа 200

Поле	Тип	Описание
`items` Обязательно	`array<Team>`	Ресурсы текущей страницы. Элементы: Team
`total` Обязательно	`integer`	Общее количество ресурсов, соответствующих запросу. Минимум: 0
`limit` Обязательно	`integer`	Размер страницы. Минимум: 1. Максимум: 100
`offset` Обязательно	`integer`	Количество пропущенных ресурсов. Минимум: 0. Максимум: 100000

Дополнительные поля запрещены.

Демонстрационный ответ

{
  "items": [
    {
      "id": "00000000-0000-4000-8000-000000000001",
      "workspaceId": "00000000-0000-4000-8000-000000000001",
      "name": "Пример названия",
      "key": "Пример"
    }
  ],
  "total": 0,
  "limit": 1,
  "offset": 0
}

GET/workspaces/{workspaceId}/statusesСсылка

Список статусов

Возвращает статусы команд, их категории, порядок и признак начального статуса. Статус задачи должен принадлежать её команде.

Разрешения: workspace:read. operationId: listStatuses

Параметры

Параметр	Где / тип	Описание
`workspaceId` Обязательно	path · `string`	UUID пространства, к которому привязан токен. uuid
`limit` Необязательно	query · `integer`	Размер страницы. По умолчанию: 50. Минимум: 1. Максимум: 100
`offset` Необязательно	query · `integer`	Количество пропущенных ресурсов. По умолчанию: 0. Минимум: 0. Максимум: 100000

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

curl --request GET "$PMLY_API/workspaces/$WORKSPACE_ID/statuses" \
  --header "Authorization: Bearer $PMLY_API_TOKEN"

Ответы

HTTP	Схема	Описание
`200`	`StatusPage`	Успешный запрос Заголовки: X-Request-Id
`400`	`Error`	Неверные параметры или тело запроса
`401`	`Error`	Токен отсутствует, истёк или отозван Заголовки: WWW-Authenticate
`403`	`Error`	Недостаточно разрешений или бизнес-прав
`404`	`Error`	Ресурс не найден или недоступен в этом пространстве
`409`	`Error`	Конфликт версии или ключа идемпотентности
`413`	`Error`	Тело запроса слишком велико
`429`	`Error`	Лимит запросов; подождите Retry-After секунд Заголовки: Retry-After
`500`	`Error`	Internal error

Схема и пример ответа 200

Поле	Тип	Описание
`items` Обязательно	`array<Status>`	Ресурсы текущей страницы. Элементы: Status
`total` Обязательно	`integer`	Общее количество ресурсов, соответствующих запросу. Минимум: 0
`limit` Обязательно	`integer`	Размер страницы. Минимум: 1. Максимум: 100
`offset` Обязательно	`integer`	Количество пропущенных ресурсов. Минимум: 0. Максимум: 100000

Дополнительные поля запрещены.

Демонстрационный ответ

{
  "items": [
    {
      "id": "00000000-0000-4000-8000-000000000001",
      "teamId": "00000000-0000-4000-8000-000000000001",
      "label": "Пример",
      "category": "backlog",
      "order": 0,
      "defaultStatus": false
    }
  ],
  "total": 0,
  "limit": 1,
  "offset": 0
}

GET/workspaces/{workspaceId}/membersСсылка

Список участников

Возвращает активных участников пространства и их роли без адресов email. Для назначения задачи используйте userId участника.

Разрешения: workspace:read. operationId: listMembers

Параметры

Параметр	Где / тип	Описание
`workspaceId` Обязательно	path · `string`	UUID пространства, к которому привязан токен. uuid
`limit` Необязательно	query · `integer`	Размер страницы. По умолчанию: 50. Минимум: 1. Максимум: 100
`offset` Необязательно	query · `integer`	Количество пропущенных ресурсов. По умолчанию: 0. Минимум: 0. Максимум: 100000

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

curl --request GET "$PMLY_API/workspaces/$WORKSPACE_ID/members" \
  --header "Authorization: Bearer $PMLY_API_TOKEN"

Ответы

HTTP	Схема	Описание
`200`	`MemberPage`	Успешный запрос Заголовки: X-Request-Id
`400`	`Error`	Неверные параметры или тело запроса
`401`	`Error`	Токен отсутствует, истёк или отозван Заголовки: WWW-Authenticate
`403`	`Error`	Недостаточно разрешений или бизнес-прав
`404`	`Error`	Ресурс не найден или недоступен в этом пространстве
`409`	`Error`	Конфликт версии или ключа идемпотентности
`413`	`Error`	Тело запроса слишком велико
`429`	`Error`	Лимит запросов; подождите Retry-After секунд Заголовки: Retry-After
`500`	`Error`	Internal error

Схема и пример ответа 200

Поле	Тип	Описание
`items` Обязательно	`array<Member>`	Ресурсы текущей страницы. Элементы: Member
`total` Обязательно	`integer`	Общее количество ресурсов, соответствующих запросу. Минимум: 0
`limit` Обязательно	`integer`	Размер страницы. Минимум: 1. Максимум: 100
`offset` Обязательно	`integer`	Количество пропущенных ресурсов. Минимум: 0. Максимум: 100000

Дополнительные поля запрещены.

Демонстрационный ответ

{
  "items": [
    {
      "userId": "00000000-0000-4000-8000-000000000001",
      "displayName": "Пример",
      "role": "OWNER"
    }
  ],
  "total": 0,
  "limit": 1,
  "offset": 0
}

GET/workspaces/{workspaceId}/issuesСсылка

Список задач

Возвращает страницу задач. Поиск: точный отображаемый ID либо вхождение в название без учёта регистра. Переданный пустой q возвращает пустую выдачу. Разные фильтры объединяются AND, повторные значения одного поля — OR.

Разрешения: issues:read. operationId: listIssues

Параметры

Параметр	Где / тип	Описание
`workspaceId` Обязательно	path · `string`	UUID пространства, к которому привязан токен. uuid
`limit` Необязательно	query · `integer`	Размер страницы. По умолчанию: 50. Минимум: 1. Максимум: 100
`offset` Необязательно	query · `integer`	Количество пропущенных ресурсов. По умолчанию: 0. Минимум: 0. Максимум: 100000
`q` Необязательно	query · `string`	Точный отображаемый ID или вхождение в название без учёта регистра. Явный пустой q возвращает пустую выдачу.
`projectId` Необязательно	query · `array<string>`	Повторные значения объединяются OR, разные поля — AND. Для projectId, assigneeId и cycleId допустимо none. Элементы: string
`statusId` Необязательно	query · `array<string>`	Повторные значения объединяются OR, разные поля — AND. Для projectId, assigneeId и cycleId допустимо none. Элементы: string
`assigneeId` Необязательно	query · `array<string>`	Повторные значения объединяются OR, разные поля — AND. Для projectId, assigneeId и cycleId допустимо none. Элементы: string
`priority` Необязательно	query · `array<integer>`	Повторные значения объединяются OR, разные поля — AND. Для projectId, assigneeId и cycleId допустимо none. Элементы: integer. Минимум: 0. Максимум: 4
`cycleId` Необязательно	query · `array<string>`	Повторные значения объединяются OR, разные поля — AND. Для projectId, assigneeId и cycleId допустимо none. Элементы: string
`category` Необязательно	query · `array<string>`	Повторные значения объединяются OR, разные поля — AND. Для projectId, assigneeId и cycleId допустимо none. Элементы: string
`groupBy` Необязательно	query · `string`	Поле группировки. Значения: "none", "status", "priority", "assignee", "project", "cycle"
`sortBy` Необязательно	query · `string`	Поле сортировки. Значения: "createdAt", "updatedAt", "priority"
`sortDirection` Необязательно	query · `string`	Направление сортировки. Значения: "asc", "desc"

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

curl --request GET "$PMLY_API/workspaces/$WORKSPACE_ID/issues" \
  --header "Authorization: Bearer $PMLY_API_TOKEN"

Ответы

HTTP	Схема	Описание
`200`	`IssuePage`	Успешный запрос Заголовки: X-Request-Id
`400`	`Error`	Неверные параметры или тело запроса
`401`	`Error`	Токен отсутствует, истёк или отозван Заголовки: WWW-Authenticate
`403`	`Error`	Недостаточно разрешений или бизнес-прав
`404`	`Error`	Ресурс не найден или недоступен в этом пространстве
`409`	`Error`	Конфликт версии или ключа идемпотентности
`413`	`Error`	Тело запроса слишком велико
`429`	`Error`	Лимит запросов; подождите Retry-After секунд Заголовки: Retry-After
`500`	`Error`	Internal error

Схема и пример ответа 200

Поле	Тип	Описание
`items` Обязательно	`array<Issue>`	Ресурсы текущей страницы. Элементы: Issue
`total` Обязательно	`integer`	Общее количество ресурсов, соответствующих запросу. Минимум: 0
`limit` Обязательно	`integer`	Размер страницы. Минимум: 1. Максимум: 100
`offset` Обязательно	`integer`	Количество пропущенных ресурсов. Минимум: 0. Максимум: 100000

Дополнительные поля запрещены.

Демонстрационный ответ

{
  "items": [
    {
      "id": "00000000-0000-4000-8000-000000000001",
      "workspaceId": "00000000-0000-4000-8000-000000000001",
      "teamId": "00000000-0000-4000-8000-000000000001",
      "projectId": "00000000-0000-4000-8000-000000000001",
      "statusId": "00000000-0000-4000-8000-000000000001",
      "assigneeId": "00000000-0000-4000-8000-000000000001",
      "number": 1,
      "identifier": "API-1",
      "title": "Задача через API",
      "description": "Пример",
      "priority": 0,
      "version": 1,
      "createdAt": "2026-09-30T10:00:00Z",
      "updatedAt": "2026-09-30T10:00:00Z",
      "cycleId": "00000000-0000-4000-8000-000000000001"
    }
  ],
  "total": 0,
  "limit": 1,
  "offset": 0
}

POST/workspaces/{workspaceId}/issuesСсылка

Создать задачу

Создаёт задачу с обязательными teamId и title. При отсутствии statusId используется начальный статус команды; приоритет по умолчанию 0. Ссылки на проект, статус, участника и цикл проверяются в границах пространства и команды. Нужен Idempotency-Key.

Разрешения: issues:write. operationId: createIssue

Параметры

Параметр	Где / тип	Описание
`workspaceId` Обязательно	path · `string`	UUID пространства, к которому привязан токен. uuid
`Idempotency-Key` Обязательно	header · `string`	Уникальный ключ создания длиной 1–128 символов. Повтор того же нормализованного запроса возвращает первоначальный успешный ответ в течение 24 часов. Минимальная длина: 1. Максимальная длина: 128

Тело запроса

Content-Type: application/json · обязательно

Поле	Тип	Описание
`teamId` Обязательно	`string`	UUID команды ресурса. uuid
`projectId` Необязательно	`string \| null`	UUID проекта. null означает отсутствие проекта. uuid
`statusId` Необязательно	`string`	UUID статуса команды задачи. uuid
`assigneeId` Необязательно	`string \| null`	UUID активного участника. null снимает назначение. uuid
`title` Обязательно	`string`	Название задачи. Минимальная длина: 1. Максимальная длина: 200
`description` Необязательно	`string`	Описание. Пустая строка очищает текст. Максимальная длина: 20000
`priority` Необязательно	`integer`	Приоритет: 0 — без приоритета, 1 — срочный, 2 — высокий, 3 — средний, 4 — низкий. Минимум: 0. Максимум: 4
`cycleId` Необязательно	`string \| null`	UUID цикла команды. null снимает цикл. uuid

Дополнительные поля запрещены.

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

curl --request POST "$PMLY_API/workspaces/$WORKSPACE_ID/issues" \
  --header "Authorization: Bearer $PMLY_API_TOKEN" \
  --header "Idempotency-Key: $IDEMPOTENCY_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "teamId": "00000000-0000-4000-8000-000000000001",
  "title": "Задача через API"
}'

Ответы

HTTP	Схема	Описание
`201`	`Issue`	Ресурс создан; повтор возвращает первоначальный ответ Заголовки: X-Request-Id
`400`	`Error`	Неверные параметры или тело запроса
`401`	`Error`	Токен отсутствует, истёк или отозван Заголовки: WWW-Authenticate
`403`	`Error`	Недостаточно разрешений или бизнес-прав
`404`	`Error`	Ресурс не найден или недоступен в этом пространстве
`409`	`Error`	Конфликт версии или ключа идемпотентности
`413`	`Error`	Тело запроса слишком велико
`429`	`Error`	Лимит запросов; подождите Retry-After секунд Заголовки: Retry-After
`500`	`Error`	Internal error

Схема и пример ответа 201

Поле	Тип	Описание
`id` Обязательно	`string`	Постоянный UUID ресурса. uuid
`workspaceId` Обязательно	`string`	UUID пространства, к которому привязан токен. uuid
`teamId` Обязательно	`string`	UUID команды ресурса. uuid
`projectId` Обязательно	`string \| null`	UUID проекта. null означает отсутствие проекта. uuid
`statusId` Обязательно	`string`	UUID статуса команды задачи. uuid
`assigneeId` Обязательно	`string \| null`	UUID активного участника. null снимает назначение. uuid
`number` Обязательно	`integer`	Номер задачи, назначенный сервером; уникален в команде. Минимум: 1
`identifier` Обязательно	`string`	Отображаемый ID задачи, например API-1.
`title` Обязательно	`string`	Название задачи. Минимальная длина: 1. Максимальная длина: 200
`description` Обязательно	`string`	Описание. Пустая строка очищает текст. Максимальная длина: 20000
`priority` Обязательно	`integer`	Приоритет: 0 — без приоритета, 1 — срочный, 2 — высокий, 3 — средний, 4 — низкий. Минимум: 0. Максимум: 4
`version` Обязательно	`integer`	Текущая версия ресурса; обязательна для изменения. Минимум: 1
`createdAt` Обязательно	`string`	Дата и время создания в UTC. date-time
`updatedAt` Обязательно	`string`	Дата и время последнего изменения в UTC. date-time
`cycleId` Обязательно	`string \| null`	UUID цикла команды. null снимает цикл. uuid

Дополнительные поля запрещены.

Демонстрационный ответ

{
  "id": "00000000-0000-4000-8000-000000000001",
  "workspaceId": "00000000-0000-4000-8000-000000000001",
  "teamId": "00000000-0000-4000-8000-000000000001",
  "projectId": "00000000-0000-4000-8000-000000000001",
  "statusId": "00000000-0000-4000-8000-000000000001",
  "assigneeId": "00000000-0000-4000-8000-000000000001",
  "number": 1,
  "identifier": "API-1",
  "title": "Задача через API",
  "description": "Пример",
  "priority": 0,
  "version": 1,
  "createdAt": "2026-09-30T10:00:00Z",
  "updatedAt": "2026-09-30T10:00:00Z",
  "cycleId": "00000000-0000-4000-8000-000000000001"
}

GET/workspaces/{workspaceId}/issues/{issueId}Ссылка

Получить задачу

Возвращает сохранённые поля задачи и текущую version. Используйте UUID id в маршрутах; identifier предназначен для отображения и поиска.

Разрешения: issues:read. operationId: getIssue

Параметры

Параметр	Где / тип	Описание
`workspaceId` Обязательно	path · `string`	UUID пространства, к которому привязан токен. uuid
`issueId` Обязательно	path · `string`	UUID ресурса в указанном пространстве. uuid

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

curl --request GET "$PMLY_API/workspaces/$WORKSPACE_ID/issues/$ISSUE_ID" \
  --header "Authorization: Bearer $PMLY_API_TOKEN"

Ответы

HTTP	Схема	Описание
`200`	`Issue`	Успешный запрос Заголовки: X-Request-Id
`400`	`Error`	Неверные параметры или тело запроса
`401`	`Error`	Токен отсутствует, истёк или отозван Заголовки: WWW-Authenticate
`403`	`Error`	Недостаточно разрешений или бизнес-прав
`404`	`Error`	Ресурс не найден или недоступен в этом пространстве
`409`	`Error`	Конфликт версии или ключа идемпотентности
`413`	`Error`	Тело запроса слишком велико
`429`	`Error`	Лимит запросов; подождите Retry-After секунд Заголовки: Retry-After
`500`	`Error`	Internal error

Схема и пример ответа 200

Поле	Тип	Описание
`id` Обязательно	`string`	Постоянный UUID ресурса. uuid
`workspaceId` Обязательно	`string`	UUID пространства, к которому привязан токен. uuid
`teamId` Обязательно	`string`	UUID команды ресурса. uuid
`projectId` Обязательно	`string \| null`	UUID проекта. null означает отсутствие проекта. uuid
`statusId` Обязательно	`string`	UUID статуса команды задачи. uuid
`assigneeId` Обязательно	`string \| null`	UUID активного участника. null снимает назначение. uuid
`number` Обязательно	`integer`	Номер задачи, назначенный сервером; уникален в команде. Минимум: 1
`identifier` Обязательно	`string`	Отображаемый ID задачи, например API-1.
`title` Обязательно	`string`	Название задачи. Минимальная длина: 1. Максимальная длина: 200
`description` Обязательно	`string`	Описание. Пустая строка очищает текст. Максимальная длина: 20000
`priority` Обязательно	`integer`	Приоритет: 0 — без приоритета, 1 — срочный, 2 — высокий, 3 — средний, 4 — низкий. Минимум: 0. Максимум: 4
`version` Обязательно	`integer`	Текущая версия ресурса; обязательна для изменения. Минимум: 1
`createdAt` Обязательно	`string`	Дата и время создания в UTC. date-time
`updatedAt` Обязательно	`string`	Дата и время последнего изменения в UTC. date-time
`cycleId` Обязательно	`string \| null`	UUID цикла команды. null снимает цикл. uuid

Дополнительные поля запрещены.

Демонстрационный ответ

{
  "id": "00000000-0000-4000-8000-000000000001",
  "workspaceId": "00000000-0000-4000-8000-000000000001",
  "teamId": "00000000-0000-4000-8000-000000000001",
  "projectId": "00000000-0000-4000-8000-000000000001",
  "statusId": "00000000-0000-4000-8000-000000000001",
  "assigneeId": "00000000-0000-4000-8000-000000000001",
  "number": 1,
  "identifier": "API-1",
  "title": "Задача через API",
  "description": "Пример",
  "priority": 0,
  "version": 1,
  "createdAt": "2026-09-30T10:00:00Z",
  "updatedAt": "2026-09-30T10:00:00Z",
  "cycleId": "00000000-0000-4000-8000-000000000001"
}

PATCH/workspaces/{workspaceId}/issues/{issueId}Ссылка

Изменить задачу

Меняет только переданные поля задачи. Требует актуальную version. null снимает projectId, assigneeId или cycleId; пустое описание очищает текст. teamId изменить нельзя. Устаревшая версия даёт 409 даже при отсутствии изменений.

Разрешения: issues:write. operationId: updateIssue

Параметры

Параметр	Где / тип	Описание
`workspaceId` Обязательно	path · `string`	UUID пространства, к которому привязан токен. uuid
`issueId` Обязательно	path · `string`	UUID ресурса в указанном пространстве. uuid

Тело запроса

Content-Type: application/json · обязательно

Поле	Тип	Описание
`version` Обязательно	`integer`	Текущая версия ресурса; обязательна для изменения. Минимум: 1
`projectId` Необязательно	`string \| null`	UUID проекта. null означает отсутствие проекта. uuid
`statusId` Необязательно	`string`	UUID статуса команды задачи. uuid
`assigneeId` Необязательно	`string \| null`	UUID активного участника. null снимает назначение. uuid
`title` Необязательно	`string`	Название задачи. Минимальная длина: 1. Максимальная длина: 200
`description` Необязательно	`string`	Описание. Пустая строка очищает текст. Максимальная длина: 20000
`priority` Необязательно	`integer`	Приоритет: 0 — без приоритета, 1 — срочный, 2 — высокий, 3 — средний, 4 — низкий. Минимум: 0. Максимум: 4
`cycleId` Необязательно	`string \| null`	UUID цикла команды. null снимает цикл. uuid

Дополнительные поля запрещены.

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

curl --request PATCH "$PMLY_API/workspaces/$WORKSPACE_ID/issues/$ISSUE_ID" \
  --header "Authorization: Bearer $PMLY_API_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
  "version": 1,
  "priority": 2
}'

Ответы

HTTP	Схема	Описание
`200`	`Issue`	Успешный запрос Заголовки: X-Request-Id
`400`	`Error`	Неверные параметры или тело запроса
`401`	`Error`	Токен отсутствует, истёк или отозван Заголовки: WWW-Authenticate
`403`	`Error`	Недостаточно разрешений или бизнес-прав
`404`	`Error`	Ресурс не найден или недоступен в этом пространстве
`409`	`Error`	Конфликт версии или ключа идемпотентности
`413`	`Error`	Тело запроса слишком велико
`429`	`Error`	Лимит запросов; подождите Retry-After секунд Заголовки: Retry-After
`500`	`Error`	Internal error

Схема и пример ответа 200

Поле	Тип	Описание
`id` Обязательно	`string`	Постоянный UUID ресурса. uuid
`workspaceId` Обязательно	`string`	UUID пространства, к которому привязан токен. uuid
`teamId` Обязательно	`string`	UUID команды ресурса. uuid
`projectId` Обязательно	`string \| null`	UUID проекта. null означает отсутствие проекта. uuid
`statusId` Обязательно	`string`	UUID статуса команды задачи. uuid
`assigneeId` Обязательно	`string \| null`	UUID активного участника. null снимает назначение. uuid
`number` Обязательно	`integer`	Номер задачи, назначенный сервером; уникален в команде. Минимум: 1
`identifier` Обязательно	`string`	Отображаемый ID задачи, например API-1.
`title` Обязательно	`string`	Название задачи. Минимальная длина: 1. Максимальная длина: 200
`description` Обязательно	`string`	Описание. Пустая строка очищает текст. Максимальная длина: 20000
`priority` Обязательно	`integer`	Приоритет: 0 — без приоритета, 1 — срочный, 2 — высокий, 3 — средний, 4 — низкий. Минимум: 0. Максимум: 4
`version` Обязательно	`integer`	Текущая версия ресурса; обязательна для изменения. Минимум: 1
`createdAt` Обязательно	`string`	Дата и время создания в UTC. date-time
`updatedAt` Обязательно	`string`	Дата и время последнего изменения в UTC. date-time
`cycleId` Обязательно	`string \| null`	UUID цикла команды. null снимает цикл. uuid

Дополнительные поля запрещены.

Демонстрационный ответ

{
  "id": "00000000-0000-4000-8000-000000000001",
  "workspaceId": "00000000-0000-4000-8000-000000000001",
  "teamId": "00000000-0000-4000-8000-000000000001",
  "projectId": "00000000-0000-4000-8000-000000000001",
  "statusId": "00000000-0000-4000-8000-000000000001",
  "assigneeId": "00000000-0000-4000-8000-000000000001",
  "number": 1,
  "identifier": "API-1",
  "title": "Задача через API",
  "description": "Пример",
  "priority": 0,
  "version": 1,
  "createdAt": "2026-09-30T10:00:00Z",
  "updatedAt": "2026-09-30T10:00:00Z",
  "cycleId": "00000000-0000-4000-8000-000000000001"
}

GET/workspaces/{workspaceId}/projectsСсылка

Список проектов

Возвращает страницу ресурсов пространства с items, total, limit и offset. Данные доступны в пределах прав пользователя и токена.

Разрешения: projects:read. operationId: listProjects

Параметры

Параметр	Где / тип	Описание
`workspaceId` Обязательно	path · `string`	UUID пространства, к которому привязан токен. uuid
`limit` Необязательно	query · `integer`	Размер страницы. По умолчанию: 50. Минимум: 1. Максимум: 100
`offset` Необязательно	query · `integer`	Количество пропущенных ресурсов. По умолчанию: 0. Минимум: 0. Максимум: 100000

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

curl --request GET "$PMLY_API/workspaces/$WORKSPACE_ID/projects" \
  --header "Authorization: Bearer $PMLY_API_TOKEN"

Ответы

HTTP	Схема	Описание
`200`	`ProjectPage`	Успешный запрос Заголовки: X-Request-Id
`400`	`Error`	Неверные параметры или тело запроса
`401`	`Error`	Токен отсутствует, истёк или отозван Заголовки: WWW-Authenticate
`403`	`Error`	Недостаточно разрешений или бизнес-прав
`404`	`Error`	Ресурс не найден или недоступен в этом пространстве
`409`	`Error`	Конфликт версии или ключа идемпотентности
`413`	`Error`	Тело запроса слишком велико
`429`	`Error`	Лимит запросов; подождите Retry-After секунд Заголовки: Retry-After
`500`	`Error`	Internal error

Схема и пример ответа 200

Поле	Тип	Описание
`items` Обязательно	`array<Project>`	Ресурсы текущей страницы. Элементы: Project
`total` Обязательно	`integer`	Общее количество ресурсов, соответствующих запросу. Минимум: 0
`limit` Обязательно	`integer`	Размер страницы. Минимум: 1. Максимум: 100
`offset` Обязательно	`integer`	Количество пропущенных ресурсов. Минимум: 0. Максимум: 100000

Дополнительные поля запрещены.

Демонстрационный ответ

{
  "items": [
    {
      "id": "00000000-0000-4000-8000-000000000001",
      "teamId": "00000000-0000-4000-8000-000000000001",
      "name": "Пример названия",
      "description": "Пример",
      "version": 1
    }
  ],
  "total": 0,
  "limit": 1,
  "offset": 0
}

POST/workspaces/{workspaceId}/projectsСсылка

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

Создаёт проект в указанной команде с обязательным именем. Нужен Idempotency-Key.

Разрешения: projects:write. operationId: createProject

Параметры

Параметр	Где / тип	Описание
`workspaceId` Обязательно	path · `string`	UUID пространства, к которому привязан токен. uuid
`Idempotency-Key` Обязательно	header · `string`	Уникальный ключ создания длиной 1–128 символов. Повтор того же нормализованного запроса возвращает первоначальный успешный ответ в течение 24 часов. Минимальная длина: 1. Максимальная длина: 128

Тело запроса

Content-Type: application/json · обязательно

Поле	Тип	Описание
`teamId` Обязательно	`string`	UUID команды ресурса. uuid
`name` Обязательно	`string`	Название ресурса. Минимальная длина: 1. Максимальная длина: 100
`description` Необязательно	`string`	Описание. Пустая строка очищает текст. Максимальная длина: 20000

Дополнительные поля запрещены.

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

curl --request POST "$PMLY_API/workspaces/$WORKSPACE_ID/projects" \
  --header "Authorization: Bearer $PMLY_API_TOKEN" \
  --header "Idempotency-Key: $IDEMPOTENCY_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "teamId": "00000000-0000-4000-8000-000000000001",
  "name": "Новый проект"
}'

Ответы

HTTP	Схема	Описание
`201`	`Project`	Ресурс создан; повтор возвращает первоначальный ответ Заголовки: X-Request-Id
`400`	`Error`	Неверные параметры или тело запроса
`401`	`Error`	Токен отсутствует, истёк или отозван Заголовки: WWW-Authenticate
`403`	`Error`	Недостаточно разрешений или бизнес-прав
`404`	`Error`	Ресурс не найден или недоступен в этом пространстве
`409`	`Error`	Конфликт версии или ключа идемпотентности
`413`	`Error`	Тело запроса слишком велико
`429`	`Error`	Лимит запросов; подождите Retry-After секунд Заголовки: Retry-After
`500`	`Error`	Internal error

Схема и пример ответа 201

Поле	Тип	Описание
`id` Обязательно	`string`	Постоянный UUID ресурса. uuid
`teamId` Обязательно	`string`	UUID команды ресурса. uuid
`name` Обязательно	`string`	Название ресурса. Минимальная длина: 1. Максимальная длина: 100
`description` Обязательно	`string`	Описание. Пустая строка очищает текст. Максимальная длина: 20000
`version` Обязательно	`integer`	Текущая версия ресурса; обязательна для изменения. Минимум: 1

Дополнительные поля запрещены.

Демонстрационный ответ

{
  "id": "00000000-0000-4000-8000-000000000001",
  "teamId": "00000000-0000-4000-8000-000000000001",
  "name": "Пример названия",
  "description": "Пример",
  "version": 1
}

GET/workspaces/{workspaceId}/projects/{projectId}Ссылка

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

Возвращает проект и текущую version для последующего изменения.

Разрешения: projects:read. operationId: getProject

Параметры

Параметр	Где / тип	Описание
`workspaceId` Обязательно	path · `string`	UUID пространства, к которому привязан токен. uuid
`projectId` Обязательно	path · `string`	UUID проекта. null означает отсутствие проекта. uuid

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

curl --request GET "$PMLY_API/workspaces/$WORKSPACE_ID/projects/$PROJECT_ID" \
  --header "Authorization: Bearer $PMLY_API_TOKEN"

Ответы

HTTP	Схема	Описание
`200`	`Project`	Успешный запрос Заголовки: X-Request-Id
`400`	`Error`	Неверные параметры или тело запроса
`401`	`Error`	Токен отсутствует, истёк или отозван Заголовки: WWW-Authenticate
`403`	`Error`	Недостаточно разрешений или бизнес-прав
`404`	`Error`	Ресурс не найден или недоступен в этом пространстве
`409`	`Error`	Конфликт версии или ключа идемпотентности
`413`	`Error`	Тело запроса слишком велико
`429`	`Error`	Лимит запросов; подождите Retry-After секунд Заголовки: Retry-After
`500`	`Error`	Internal error

Схема и пример ответа 200

Поле	Тип	Описание
`id` Обязательно	`string`	Постоянный UUID ресурса. uuid
`teamId` Обязательно	`string`	UUID команды ресурса. uuid
`name` Обязательно	`string`	Название ресурса. Минимальная длина: 1. Максимальная длина: 100
`description` Обязательно	`string`	Описание. Пустая строка очищает текст. Максимальная длина: 20000
`version` Обязательно	`integer`	Текущая версия ресурса; обязательна для изменения. Минимум: 1

Дополнительные поля запрещены.

Демонстрационный ответ

{
  "id": "00000000-0000-4000-8000-000000000001",
  "teamId": "00000000-0000-4000-8000-000000000001",
  "name": "Пример названия",
  "description": "Пример",
  "version": 1
}

PATCH/workspaces/{workspaceId}/projects/{projectId}Ссылка

Изменить проект

Меняет только переданные имя и описание проекта. Требует текущую version; teamId изменить нельзя.

Разрешения: projects:write. operationId: updateProject

Параметры

Параметр	Где / тип	Описание
`workspaceId` Обязательно	path · `string`	UUID пространства, к которому привязан токен. uuid
`projectId` Обязательно	path · `string`	UUID проекта. null означает отсутствие проекта. uuid

Тело запроса

Content-Type: application/json · обязательно

Поле	Тип	Описание
`version` Обязательно	`integer`	Текущая версия ресурса; обязательна для изменения. Минимум: 1
`name` Необязательно	`string`	Название ресурса. Минимальная длина: 1. Максимальная длина: 100
`description` Необязательно	`string`	Описание. Пустая строка очищает текст. Максимальная длина: 20000

Дополнительные поля запрещены.

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

curl --request PATCH "$PMLY_API/workspaces/$WORKSPACE_ID/projects/$PROJECT_ID" \
  --header "Authorization: Bearer $PMLY_API_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
  "version": 1,
  "name": "Обновлённый проект"
}'

Ответы

HTTP	Схема	Описание
`200`	`Project`	Успешный запрос Заголовки: X-Request-Id
`400`	`Error`	Неверные параметры или тело запроса
`401`	`Error`	Токен отсутствует, истёк или отозван Заголовки: WWW-Authenticate
`403`	`Error`	Недостаточно разрешений или бизнес-прав
`404`	`Error`	Ресурс не найден или недоступен в этом пространстве
`409`	`Error`	Конфликт версии или ключа идемпотентности
`413`	`Error`	Тело запроса слишком велико
`429`	`Error`	Лимит запросов; подождите Retry-After секунд Заголовки: Retry-After
`500`	`Error`	Internal error

Схема и пример ответа 200

Поле	Тип	Описание
`id` Обязательно	`string`	Постоянный UUID ресурса. uuid
`teamId` Обязательно	`string`	UUID команды ресурса. uuid
`name` Обязательно	`string`	Название ресурса. Минимальная длина: 1. Максимальная длина: 100
`description` Обязательно	`string`	Описание. Пустая строка очищает текст. Максимальная длина: 20000
`version` Обязательно	`integer`	Текущая версия ресурса; обязательна для изменения. Минимум: 1

Дополнительные поля запрещены.

Демонстрационный ответ

{
  "id": "00000000-0000-4000-8000-000000000001",
  "teamId": "00000000-0000-4000-8000-000000000001",
  "name": "Пример названия",
  "description": "Пример",
  "version": 1
}

GET/workspaces/{workspaceId}/cyclesСсылка

Список циклов

Разрешения: cycles:read. operationId: listCycles

Параметры

Параметр	Где / тип	Описание
`workspaceId` Обязательно	path · `string`	UUID пространства, к которому привязан токен. uuid
`limit` Необязательно	query · `integer`	Размер страницы. По умолчанию: 50. Минимум: 1. Максимум: 100
`offset` Необязательно	query · `integer`	Количество пропущенных ресурсов. По умолчанию: 0. Минимум: 0. Максимум: 100000

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

curl --request GET "$PMLY_API/workspaces/$WORKSPACE_ID/cycles" \
  --header "Authorization: Bearer $PMLY_API_TOKEN"

Ответы

HTTP	Схема	Описание
`200`	`CyclePage`	Успешный запрос Заголовки: X-Request-Id
`400`	`Error`	Неверные параметры или тело запроса
`401`	`Error`	Токен отсутствует, истёк или отозван Заголовки: WWW-Authenticate
`403`	`Error`	Недостаточно разрешений или бизнес-прав
`404`	`Error`	Ресурс не найден или недоступен в этом пространстве
`409`	`Error`	Конфликт версии или ключа идемпотентности
`413`	`Error`	Тело запроса слишком велико
`429`	`Error`	Лимит запросов; подождите Retry-After секунд Заголовки: Retry-After
`500`	`Error`	Internal error

Схема и пример ответа 200

Поле	Тип	Описание
`items` Обязательно	`array<Cycle>`	Ресурсы текущей страницы. Элементы: Cycle
`total` Обязательно	`integer`	Общее количество ресурсов, соответствующих запросу. Минимум: 0
`limit` Обязательно	`integer`	Размер страницы. Минимум: 1. Максимум: 100
`offset` Обязательно	`integer`	Количество пропущенных ресурсов. Минимум: 0. Максимум: 100000

Дополнительные поля запрещены.

Демонстрационный ответ

{
  "items": [
    {
      "id": "00000000-0000-4000-8000-000000000001",
      "workspaceId": "00000000-0000-4000-8000-000000000001",
      "teamId": "00000000-0000-4000-8000-000000000001",
      "name": "Пример названия",
      "startDate": "2026-10-01",
      "endDate": "2026-10-14",
      "state": "open",
      "version": 1
    }
  ],
  "total": 0,
  "limit": 1,
  "offset": 0
}

POST/workspaces/{workspaceId}/cyclesСсылка

Создать цикл

Создаёт цикл в указанной команде. Передайте имя и даты начала/окончания; начало не должно быть позже окончания. Нужен Idempotency-Key.

Разрешения: cycles:write. operationId: createCycle

Параметры

Параметр	Где / тип	Описание
`workspaceId` Обязательно	path · `string`	UUID пространства, к которому привязан токен. uuid
`Idempotency-Key` Обязательно	header · `string`	Уникальный ключ создания длиной 1–128 символов. Повтор того же нормализованного запроса возвращает первоначальный успешный ответ в течение 24 часов. Минимальная длина: 1. Максимальная длина: 128

Тело запроса

Content-Type: application/json · обязательно

Поле	Тип	Описание
`teamId` Обязательно	`string`	UUID команды ресурса. uuid
`name` Обязательно	`string`	Название ресурса. Минимальная длина: 1. Максимальная длина: 100
`startDate` Обязательно	`string`	Дата начала цикла, YYYY-MM-DD. date
`endDate` Обязательно	`string`	Дата окончания цикла, YYYY-MM-DD. date

Дополнительные поля запрещены.

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

curl --request POST "$PMLY_API/workspaces/$WORKSPACE_ID/cycles" \
  --header "Authorization: Bearer $PMLY_API_TOKEN" \
  --header "Idempotency-Key: $IDEMPOTENCY_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "teamId": "00000000-0000-4000-8000-000000000001",
  "name": "Октябрь",
  "startDate": "2026-10-01",
  "endDate": "2026-10-14"
}'

Ответы

HTTP	Схема	Описание
`201`	`Cycle`	Ресурс создан; повтор возвращает первоначальный ответ Заголовки: X-Request-Id
`400`	`Error`	Неверные параметры или тело запроса
`401`	`Error`	Токен отсутствует, истёк или отозван Заголовки: WWW-Authenticate
`403`	`Error`	Недостаточно разрешений или бизнес-прав
`404`	`Error`	Ресурс не найден или недоступен в этом пространстве
`409`	`Error`	Конфликт версии или ключа идемпотентности
`413`	`Error`	Тело запроса слишком велико
`429`	`Error`	Лимит запросов; подождите Retry-After секунд Заголовки: Retry-After
`500`	`Error`	Internal error

Схема и пример ответа 201

Поле	Тип	Описание
`id` Обязательно	`string`	Постоянный UUID ресурса. uuid
`workspaceId` Обязательно	`string`	UUID пространства, к которому привязан токен. uuid
`teamId` Обязательно	`string`	UUID команды ресурса. uuid
`name` Обязательно	`string`	Название ресурса. Минимальная длина: 1. Максимальная длина: 100
`startDate` Обязательно	`string`	Дата начала цикла, YYYY-MM-DD. date
`endDate` Обязательно	`string`	Дата окончания цикла, YYYY-MM-DD. date
`state` Обязательно	`string`	Состояние цикла. Значения: "open", "completed"
`version` Обязательно	`integer`	Текущая версия ресурса; обязательна для изменения. Минимум: 1

Дополнительные поля запрещены.

Демонстрационный ответ

{
  "id": "00000000-0000-4000-8000-000000000001",
  "workspaceId": "00000000-0000-4000-8000-000000000001",
  "teamId": "00000000-0000-4000-8000-000000000001",
  "name": "Пример названия",
  "startDate": "2026-10-01",
  "endDate": "2026-10-14",
  "state": "open",
  "version": 1
}

GET/workspaces/{workspaceId}/cycles/{cycleId}Ссылка

Получить цикл

Возвращает цикл, диапазон дат, состояние и текущую version.

Разрешения: cycles:read. operationId: getCycle

Параметры

Параметр	Где / тип	Описание
`workspaceId` Обязательно	path · `string`	UUID пространства, к которому привязан токен. uuid
`cycleId` Обязательно	path · `string`	UUID цикла команды. null снимает цикл. uuid

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

curl --request GET "$PMLY_API/workspaces/$WORKSPACE_ID/cycles/$CYCLE_ID" \
  --header "Authorization: Bearer $PMLY_API_TOKEN"

Ответы

HTTP	Схема	Описание
`200`	`Cycle`	Успешный запрос Заголовки: X-Request-Id
`400`	`Error`	Неверные параметры или тело запроса
`401`	`Error`	Токен отсутствует, истёк или отозван Заголовки: WWW-Authenticate
`403`	`Error`	Недостаточно разрешений или бизнес-прав
`404`	`Error`	Ресурс не найден или недоступен в этом пространстве
`409`	`Error`	Конфликт версии или ключа идемпотентности
`413`	`Error`	Тело запроса слишком велико
`429`	`Error`	Лимит запросов; подождите Retry-After секунд Заголовки: Retry-After
`500`	`Error`	Internal error

Схема и пример ответа 200

Поле	Тип	Описание
`id` Обязательно	`string`	Постоянный UUID ресурса. uuid
`workspaceId` Обязательно	`string`	UUID пространства, к которому привязан токен. uuid
`teamId` Обязательно	`string`	UUID команды ресурса. uuid
`name` Обязательно	`string`	Название ресурса. Минимальная длина: 1. Максимальная длина: 100
`startDate` Обязательно	`string`	Дата начала цикла, YYYY-MM-DD. date
`endDate` Обязательно	`string`	Дата окончания цикла, YYYY-MM-DD. date
`state` Обязательно	`string`	Состояние цикла. Значения: "open", "completed"
`version` Обязательно	`integer`	Текущая версия ресурса; обязательна для изменения. Минимум: 1

Дополнительные поля запрещены.

Демонстрационный ответ

{
  "id": "00000000-0000-4000-8000-000000000001",
  "workspaceId": "00000000-0000-4000-8000-000000000001",
  "teamId": "00000000-0000-4000-8000-000000000001",
  "name": "Пример названия",
  "startDate": "2026-10-01",
  "endDate": "2026-10-14",
  "state": "open",
  "version": 1
}

PATCH/workspaces/{workspaceId}/cycles/{cycleId}Ссылка

Изменить цикл

Меняет только переданные имя и даты цикла с проверкой актуальной version.

Разрешения: cycles:write. operationId: updateCycle

Параметры

Параметр	Где / тип	Описание
`workspaceId` Обязательно	path · `string`	UUID пространства, к которому привязан токен. uuid
`cycleId` Обязательно	path · `string`	UUID цикла команды. null снимает цикл. uuid

Тело запроса

Content-Type: application/json · обязательно

Поле	Тип	Описание
`version` Обязательно	`integer`	Текущая версия ресурса; обязательна для изменения. Минимум: 1
`name` Необязательно	`string`	Название ресурса. Минимальная длина: 1. Максимальная длина: 100
`startDate` Необязательно	`string`	Дата начала цикла, YYYY-MM-DD. date
`endDate` Необязательно	`string`	Дата окончания цикла, YYYY-MM-DD. date

Дополнительные поля запрещены.

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

curl --request PATCH "$PMLY_API/workspaces/$WORKSPACE_ID/cycles/$CYCLE_ID" \
  --header "Authorization: Bearer $PMLY_API_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
  "version": 1,
  "name": "Обновлённый цикл"
}'

Ответы

HTTP	Схема	Описание
`200`	`Cycle`	Успешный запрос Заголовки: X-Request-Id
`400`	`Error`	Неверные параметры или тело запроса
`401`	`Error`	Токен отсутствует, истёк или отозван Заголовки: WWW-Authenticate
`403`	`Error`	Недостаточно разрешений или бизнес-прав
`404`	`Error`	Ресурс не найден или недоступен в этом пространстве
`409`	`Error`	Конфликт версии или ключа идемпотентности
`413`	`Error`	Тело запроса слишком велико
`429`	`Error`	Лимит запросов; подождите Retry-After секунд Заголовки: Retry-After
`500`	`Error`	Internal error

Схема и пример ответа 200

Поле	Тип	Описание
`id` Обязательно	`string`	Постоянный UUID ресурса. uuid
`workspaceId` Обязательно	`string`	UUID пространства, к которому привязан токен. uuid
`teamId` Обязательно	`string`	UUID команды ресурса. uuid
`name` Обязательно	`string`	Название ресурса. Минимальная длина: 1. Максимальная длина: 100
`startDate` Обязательно	`string`	Дата начала цикла, YYYY-MM-DD. date
`endDate` Обязательно	`string`	Дата окончания цикла, YYYY-MM-DD. date
`state` Обязательно	`string`	Состояние цикла. Значения: "open", "completed"
`version` Обязательно	`integer`	Текущая версия ресурса; обязательна для изменения. Минимум: 1

Дополнительные поля запрещены.

Демонстрационный ответ

{
  "id": "00000000-0000-4000-8000-000000000001",
  "workspaceId": "00000000-0000-4000-8000-000000000001",
  "teamId": "00000000-0000-4000-8000-000000000001",
  "name": "Пример названия",
  "startDate": "2026-10-01",
  "endDate": "2026-10-14",
  "state": "open",
  "version": 1
}

POST/workspaces/{workspaceId}/cycles/{cycleId}/completeСсылка

Завершить цикл

Завершает цикл с проверкой актуальной version. Это команда изменения существующего ресурса, поэтому Idempotency-Key не требуется.

Разрешения: cycles:write. operationId: completeCycle

Параметры

Параметр	Где / тип	Описание
`workspaceId` Обязательно	path · `string`	UUID пространства, к которому привязан токен. uuid
`cycleId` Обязательно	path · `string`	UUID цикла команды. null снимает цикл. uuid

Тело запроса

Content-Type: application/json · обязательно

Поле	Тип	Описание
`version` Обязательно	`integer`	Текущая версия ресурса; обязательна для изменения. Минимум: 1

Дополнительные поля запрещены.

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

curl --request POST "$PMLY_API/workspaces/$WORKSPACE_ID/cycles/$CYCLE_ID/complete" \
  --header "Authorization: Bearer $PMLY_API_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
  "version": 1
}'

Ответы

HTTP	Схема	Описание
`200`	`Cycle`	Успешный запрос Заголовки: X-Request-Id
`400`	`Error`	Неверные параметры или тело запроса
`401`	`Error`	Токен отсутствует, истёк или отозван Заголовки: WWW-Authenticate
`403`	`Error`	Недостаточно разрешений или бизнес-прав
`404`	`Error`	Ресурс не найден или недоступен в этом пространстве
`409`	`Error`	Конфликт версии или ключа идемпотентности
`413`	`Error`	Тело запроса слишком велико
`429`	`Error`	Лимит запросов; подождите Retry-After секунд Заголовки: Retry-After
`500`	`Error`	Internal error

Схема и пример ответа 200

Поле	Тип	Описание
`id` Обязательно	`string`	Постоянный UUID ресурса. uuid
`workspaceId` Обязательно	`string`	UUID пространства, к которому привязан токен. uuid
`teamId` Обязательно	`string`	UUID команды ресурса. uuid
`name` Обязательно	`string`	Название ресурса. Минимальная длина: 1. Максимальная длина: 100
`startDate` Обязательно	`string`	Дата начала цикла, YYYY-MM-DD. date
`endDate` Обязательно	`string`	Дата окончания цикла, YYYY-MM-DD. date
`state` Обязательно	`string`	Состояние цикла. Значения: "open", "completed"
`version` Обязательно	`integer`	Текущая версия ресурса; обязательна для изменения. Минимум: 1

Дополнительные поля запрещены.

Демонстрационный ответ

{
  "id": "00000000-0000-4000-8000-000000000001",
  "workspaceId": "00000000-0000-4000-8000-000000000001",
  "teamId": "00000000-0000-4000-8000-000000000001",
  "name": "Пример названия",
  "startDate": "2026-10-01",
  "endDate": "2026-10-14",
  "state": "open",
  "version": 1
}

GET/workspaces/{workspaceId}/viewsСсылка

Список представлений

Разрешения: views:read. operationId: listViews

Параметры

Параметр	Где / тип	Описание
`workspaceId` Обязательно	path · `string`	UUID пространства, к которому привязан токен. uuid
`limit` Необязательно	query · `integer`	Размер страницы. По умолчанию: 50. Минимум: 1. Максимум: 100
`offset` Необязательно	query · `integer`	Количество пропущенных ресурсов. По умолчанию: 0. Минимум: 0. Максимум: 100000

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

curl --request GET "$PMLY_API/workspaces/$WORKSPACE_ID/views" \
  --header "Authorization: Bearer $PMLY_API_TOKEN"

Ответы

HTTP	Схема	Описание
`200`	`ViewPage`	Успешный запрос Заголовки: X-Request-Id
`400`	`Error`	Неверные параметры или тело запроса
`401`	`Error`	Токен отсутствует, истёк или отозван Заголовки: WWW-Authenticate
`403`	`Error`	Недостаточно разрешений или бизнес-прав
`404`	`Error`	Ресурс не найден или недоступен в этом пространстве
`409`	`Error`	Конфликт версии или ключа идемпотентности
`413`	`Error`	Тело запроса слишком велико
`429`	`Error`	Лимит запросов; подождите Retry-After секунд Заголовки: Retry-After
`500`	`Error`	Internal error

Схема и пример ответа 200

Поле	Тип	Описание
`items` Обязательно	`array<View>`	Ресурсы текущей страницы. Элементы: View
`total` Обязательно	`integer`	Общее количество ресурсов, соответствующих запросу. Минимум: 0
`limit` Обязательно	`integer`	Размер страницы. Минимум: 1. Максимум: 100
`offset` Обязательно	`integer`	Количество пропущенных ресурсов. Минимум: 0. Максимум: 100000

Дополнительные поля запрещены.

Демонстрационный ответ

{
  "items": [
    {
      "id": "00000000-0000-4000-8000-000000000001",
      "workspaceId": "00000000-0000-4000-8000-000000000001",
      "authorId": "00000000-0000-4000-8000-000000000001",
      "name": "Пример названия",
      "settings": {
        "q": "Пример",
        "projectId": [
          "Пример"
        ],
        "statusId": [
          "Пример"
        ],
        "assigneeId": [
          "Пример"
        ],
        "cycleId": [
          "Пример"
        ],
        "category": [
          "Пример"
        ],
        "priority": [
          0
        ],
        "groupBy": "none",
        "sortBy": "createdAt",
        "sortDirection": "asc"
      },
      "version": 1
    }
  ],
  "total": 0,
  "limit": 1,
  "offset": 0
}

POST/workspaces/{workspaceId}/viewsСсылка

Создать представление

Создаёт представление с именем и настройками. Нужен Idempotency-Key.

Разрешения: views:write. operationId: createView

Параметры

Параметр	Где / тип	Описание
`workspaceId` Обязательно	path · `string`	UUID пространства, к которому привязан токен. uuid
`Idempotency-Key` Обязательно	header · `string`	Уникальный ключ создания длиной 1–128 символов. Повтор того же нормализованного запроса возвращает первоначальный успешный ответ в течение 24 часов. Минимальная длина: 1. Максимальная длина: 128

Тело запроса

Content-Type: application/json · обязательно

Поле	Тип	Описание
`name` Обязательно	`string`	Название ресурса. Минимальная длина: 1. Максимальная длина: 100
`settings` Обязательно	`ViewSettings`	Фильтры и отображение представления. При PATCH переданный объект заменяется целиком.

Дополнительные поля запрещены.

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

curl --request POST "$PMLY_API/workspaces/$WORKSPACE_ID/views" \
  --header "Authorization: Bearer $PMLY_API_TOKEN" \
  --header "Idempotency-Key: $IDEMPOTENCY_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "name": "Высокий приоритет",
  "settings": {
    "priority": [
      1,
      2
    ],
    "groupBy": "status",
    "sortBy": "updatedAt",
    "sortDirection": "desc"
  }
}'

Ответы

HTTP	Схема	Описание
`201`	`View`	Ресурс создан; повтор возвращает первоначальный ответ Заголовки: X-Request-Id
`400`	`Error`	Неверные параметры или тело запроса
`401`	`Error`	Токен отсутствует, истёк или отозван Заголовки: WWW-Authenticate
`403`	`Error`	Недостаточно разрешений или бизнес-прав
`404`	`Error`	Ресурс не найден или недоступен в этом пространстве
`409`	`Error`	Конфликт версии или ключа идемпотентности
`413`	`Error`	Тело запроса слишком велико
`429`	`Error`	Лимит запросов; подождите Retry-After секунд Заголовки: Retry-After
`500`	`Error`	Internal error

Схема и пример ответа 201

Поле	Тип	Описание
`id` Обязательно	`string`	Постоянный UUID ресурса. uuid
`workspaceId` Обязательно	`string`	UUID пространства, к которому привязан токен. uuid
`authorId` Обязательно	`string`	UUID автора. uuid
`name` Обязательно	`string`	Название ресурса. Минимальная длина: 1. Максимальная длина: 100
`settings` Обязательно	`ViewSettings`	Фильтры и отображение представления. При PATCH переданный объект заменяется целиком.
`version` Обязательно	`integer`	Текущая версия ресурса; обязательна для изменения. Минимум: 1

Дополнительные поля запрещены.

Демонстрационный ответ

{
  "id": "00000000-0000-4000-8000-000000000001",
  "workspaceId": "00000000-0000-4000-8000-000000000001",
  "authorId": "00000000-0000-4000-8000-000000000001",
  "name": "Пример названия",
  "settings": {
    "q": "Пример",
    "projectId": [
      "Пример"
    ],
    "statusId": [
      "Пример"
    ],
    "assigneeId": [
      "Пример"
    ],
    "cycleId": [
      "Пример"
    ],
    "category": [
      "Пример"
    ],
    "priority": [
      0
    ],
    "groupBy": "none",
    "sortBy": "createdAt",
    "sortDirection": "asc"
  },
  "version": 1
}

GET/workspaces/{workspaceId}/views/{viewId}Ссылка

Получить представление

Возвращает сохранённое представление с фильтрами, группировкой, сортировкой и текущей version.

Разрешения: views:read. operationId: getView

Параметры

Параметр	Где / тип	Описание
`workspaceId` Обязательно	path · `string`	UUID пространства, к которому привязан токен. uuid
`viewId` Обязательно	path · `string`	UUID ресурса в указанном пространстве. uuid

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

curl --request GET "$PMLY_API/workspaces/$WORKSPACE_ID/views/$VIEW_ID" \
  --header "Authorization: Bearer $PMLY_API_TOKEN"

Ответы

HTTP	Схема	Описание
`200`	`View`	Успешный запрос Заголовки: X-Request-Id
`400`	`Error`	Неверные параметры или тело запроса
`401`	`Error`	Токен отсутствует, истёк или отозван Заголовки: WWW-Authenticate
`403`	`Error`	Недостаточно разрешений или бизнес-прав
`404`	`Error`	Ресурс не найден или недоступен в этом пространстве
`409`	`Error`	Конфликт версии или ключа идемпотентности
`413`	`Error`	Тело запроса слишком велико
`429`	`Error`	Лимит запросов; подождите Retry-After секунд Заголовки: Retry-After
`500`	`Error`	Internal error

Схема и пример ответа 200

Поле	Тип	Описание
`id` Обязательно	`string`	Постоянный UUID ресурса. uuid
`workspaceId` Обязательно	`string`	UUID пространства, к которому привязан токен. uuid
`authorId` Обязательно	`string`	UUID автора. uuid
`name` Обязательно	`string`	Название ресурса. Минимальная длина: 1. Максимальная длина: 100
`settings` Обязательно	`ViewSettings`	Фильтры и отображение представления. При PATCH переданный объект заменяется целиком.
`version` Обязательно	`integer`	Текущая версия ресурса; обязательна для изменения. Минимум: 1

Дополнительные поля запрещены.

Демонстрационный ответ

{
  "id": "00000000-0000-4000-8000-000000000001",
  "workspaceId": "00000000-0000-4000-8000-000000000001",
  "authorId": "00000000-0000-4000-8000-000000000001",
  "name": "Пример названия",
  "settings": {
    "q": "Пример",
    "projectId": [
      "Пример"
    ],
    "statusId": [
      "Пример"
    ],
    "assigneeId": [
      "Пример"
    ],
    "cycleId": [
      "Пример"
    ],
    "category": [
      "Пример"
    ],
    "priority": [
      0
    ],
    "groupBy": "none",
    "sortBy": "createdAt",
    "sortDirection": "asc"
  },
  "version": 1
}

PATCH/workspaces/{workspaceId}/views/{viewId}Ссылка

Изменить представление

Меняет имя и/или настройки с проверкой version. Переданный объект settings заменяется целиком. Сохраняются права автора и владельца пространства.

Разрешения: views:write. operationId: updateView

Параметры

Параметр	Где / тип	Описание
`workspaceId` Обязательно	path · `string`	UUID пространства, к которому привязан токен. uuid
`viewId` Обязательно	path · `string`	UUID ресурса в указанном пространстве. uuid

Тело запроса

Content-Type: application/json · обязательно

Поле	Тип	Описание
`version` Обязательно	`integer`	Текущая версия ресурса; обязательна для изменения. Минимум: 1
`name` Необязательно	`string`	Название ресурса. Минимальная длина: 1. Максимальная длина: 100
`settings` Необязательно	`ViewSettings`	Фильтры и отображение представления. При PATCH переданный объект заменяется целиком.

Дополнительные поля запрещены.

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

curl --request PATCH "$PMLY_API/workspaces/$WORKSPACE_ID/views/$VIEW_ID" \
  --header "Authorization: Bearer $PMLY_API_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
  "version": 1,
  "name": "Обновлённое представление"
}'

Ответы

HTTP	Схема	Описание
`200`	`View`	Успешный запрос Заголовки: X-Request-Id
`400`	`Error`	Неверные параметры или тело запроса
`401`	`Error`	Токен отсутствует, истёк или отозван Заголовки: WWW-Authenticate
`403`	`Error`	Недостаточно разрешений или бизнес-прав
`404`	`Error`	Ресурс не найден или недоступен в этом пространстве
`409`	`Error`	Конфликт версии или ключа идемпотентности
`413`	`Error`	Тело запроса слишком велико
`429`	`Error`	Лимит запросов; подождите Retry-After секунд Заголовки: Retry-After
`500`	`Error`	Internal error

Схема и пример ответа 200

Поле	Тип	Описание
`id` Обязательно	`string`	Постоянный UUID ресурса. uuid
`workspaceId` Обязательно	`string`	UUID пространства, к которому привязан токен. uuid
`authorId` Обязательно	`string`	UUID автора. uuid
`name` Обязательно	`string`	Название ресурса. Минимальная длина: 1. Максимальная длина: 100
`settings` Обязательно	`ViewSettings`	Фильтры и отображение представления. При PATCH переданный объект заменяется целиком.
`version` Обязательно	`integer`	Текущая версия ресурса; обязательна для изменения. Минимум: 1

Дополнительные поля запрещены.

Демонстрационный ответ

{
  "id": "00000000-0000-4000-8000-000000000001",
  "workspaceId": "00000000-0000-4000-8000-000000000001",
  "authorId": "00000000-0000-4000-8000-000000000001",
  "name": "Пример названия",
  "settings": {
    "q": "Пример",
    "projectId": [
      "Пример"
    ],
    "statusId": [
      "Пример"
    ],
    "assigneeId": [
      "Пример"
    ],
    "cycleId": [
      "Пример"
    ],
    "category": [
      "Пример"
    ],
    "priority": [
      0
    ],
    "groupBy": "none",
    "sortBy": "createdAt",
    "sortDirection": "asc"
  },
  "version": 1
}

DELETE/workspaces/{workspaceId}/views/{viewId}Ссылка

Удалить представление

Удаляет представление с проверкой version из query-параметра. Сохраняются права автора и владельца пространства. Успех — 204 без тела.

Разрешения: views:write. operationId: deleteView

Параметры

Параметр	Где / тип	Описание
`workspaceId` Обязательно	path · `string`	UUID пространства, к которому привязан токен. uuid
`viewId` Обязательно	path · `string`	UUID ресурса в указанном пространстве. uuid
`version` Обязательно	query · `integer`	Текущая версия ресурса; обязательна для изменения. Минимум: 1

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

curl --request DELETE "$PMLY_API/workspaces/$WORKSPACE_ID/views/$VIEW_ID?version=$VERSION" \
  --header "Authorization: Bearer $PMLY_API_TOKEN"

Ответы

HTTP	Схема	Описание
`204`	Без тела	Успешное удаление, без тела Заголовки: X-Request-Id
`400`	`Error`	Неверные параметры или тело запроса
`401`	`Error`	Токен отсутствует, истёк или отозван Заголовки: WWW-Authenticate
`403`	`Error`	Недостаточно разрешений или бизнес-прав
`404`	`Error`	Ресурс не найден или недоступен в этом пространстве
`409`	`Error`	Конфликт версии или ключа идемпотентности
`413`	`Error`	Тело запроса слишком велико
`429`	`Error`	Лимит запросов; подождите Retry-After секунд Заголовки: Retry-After
`500`	`Error`	Internal error

GET/workspaces/{workspaceId}/issues/{issueId}/commentsСсылка

Список комментариев

Разрешения: comments:read. operationId: listComments

Параметры

Параметр	Где / тип	Описание
`workspaceId` Обязательно	path · `string`	UUID пространства, к которому привязан токен. uuid
`issueId` Обязательно	path · `string`	UUID ресурса в указанном пространстве. uuid
`limit` Необязательно	query · `integer`	Размер страницы. По умолчанию: 50. Минимум: 1. Максимум: 100
`offset` Необязательно	query · `integer`	Количество пропущенных ресурсов. По умолчанию: 0. Минимум: 0. Максимум: 100000

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

curl --request GET "$PMLY_API/workspaces/$WORKSPACE_ID/issues/$ISSUE_ID/comments" \
  --header "Authorization: Bearer $PMLY_API_TOKEN"

Ответы

HTTP	Схема	Описание
`200`	`CommentPage`	Успешный запрос Заголовки: X-Request-Id
`400`	`Error`	Неверные параметры или тело запроса
`401`	`Error`	Токен отсутствует, истёк или отозван Заголовки: WWW-Authenticate
`403`	`Error`	Недостаточно разрешений или бизнес-прав
`404`	`Error`	Ресурс не найден или недоступен в этом пространстве
`409`	`Error`	Конфликт версии или ключа идемпотентности
`413`	`Error`	Тело запроса слишком велико
`429`	`Error`	Лимит запросов; подождите Retry-After секунд Заголовки: Retry-After
`500`	`Error`	Internal error

Схема и пример ответа 200

Поле	Тип	Описание
`items` Обязательно	`array<Comment>`	Ресурсы текущей страницы. Элементы: Comment
`total` Обязательно	`integer`	Общее количество ресурсов, соответствующих запросу. Минимум: 0
`limit` Обязательно	`integer`	Размер страницы. Минимум: 1. Максимум: 100
`offset` Обязательно	`integer`	Количество пропущенных ресурсов. Минимум: 0. Максимум: 100000

Дополнительные поля запрещены.

Демонстрационный ответ

{
  "items": [
    {
      "id": "00000000-0000-4000-8000-000000000001",
      "workspaceId": "00000000-0000-4000-8000-000000000001",
      "issueId": "00000000-0000-4000-8000-000000000001",
      "authorId": "00000000-0000-4000-8000-000000000001",
      "authorName": "Пример",
      "body": "Комментарий через API",
      "createdAt": "2026-09-30T10:00:00Z",
      "updatedAt": "2026-09-30T10:00:00Z",
      "deletedAt": null,
      "version": 1,
      "mentions": [],
      "sourceClient": null
    }
  ],
  "total": 0,
  "limit": 1,
  "offset": 0
}

POST/workspaces/{workspaceId}/issues/{issueId}/commentsСсылка

Создать комментарий

Создаёт комментарий к задаче. Текст обрезается по краям; упоминания проверяются относительно переданного текста. Нужен Idempotency-Key. Автор назначается сервером.

Разрешения: comments:write. operationId: createComment

Параметры

Параметр	Где / тип	Описание
`workspaceId` Обязательно	path · `string`	UUID пространства, к которому привязан токен. uuid
`issueId` Обязательно	path · `string`	UUID ресурса в указанном пространстве. uuid
`Idempotency-Key` Обязательно	header · `string`	Уникальный ключ создания длиной 1–128 символов. Повтор того же нормализованного запроса возвращает первоначальный успешный ответ в течение 24 часов. Минимальная длина: 1. Максимальная длина: 128

Тело запроса

Content-Type: application/json · обязательно

Поле	Тип	Описание
`body` Обязательно	`string`	Текст комментария; пробелы по краям удаляются. У удалённого комментария текст пустой. Минимальная длина: 1. Максимальная длина: 20000
`mentions` Необязательно	`array<CommentMention>`	Непересекающиеся @упоминания участников. При изменении body без mentions очищаются; при запросе только с version сохраняются. Максимум элементов: 100. Элементы: CommentMention

Дополнительные поля запрещены.

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

curl --request POST "$PMLY_API/workspaces/$WORKSPACE_ID/issues/$ISSUE_ID/comments" \
  --header "Authorization: Bearer $PMLY_API_TOKEN" \
  --header "Idempotency-Key: $IDEMPOTENCY_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "body": "Комментарий через API"
}'

Ответы

HTTP	Схема	Описание
`201`	`Comment`	Ресурс создан; повтор возвращает первоначальный ответ Заголовки: X-Request-Id
`400`	`Error`	Неверные параметры или тело запроса
`401`	`Error`	Токен отсутствует, истёк или отозван Заголовки: WWW-Authenticate
`403`	`Error`	Недостаточно разрешений или бизнес-прав
`404`	`Error`	Ресурс не найден или недоступен в этом пространстве
`409`	`Error`	Конфликт версии или ключа идемпотентности
`413`	`Error`	Тело запроса слишком велико
`429`	`Error`	Лимит запросов; подождите Retry-After секунд Заголовки: Retry-After
`500`	`Error`	Internal error

Схема и пример ответа 201

Поле	Тип	Описание
`id` Обязательно	`string`	Постоянный UUID ресурса. uuid
`workspaceId` Обязательно	`string`	UUID пространства, к которому привязан токен. uuid
`issueId` Обязательно	`string`	uuid
`authorId` Обязательно	`string`	UUID автора. uuid
`authorName` Обязательно	`string`	Имя автора.
`body` Обязательно	`string`	Текст комментария; пробелы по краям удаляются. У удалённого комментария текст пустой. Максимальная длина: 20000
`createdAt` Обязательно	`string`	Дата и время создания в UTC. date-time
`updatedAt` Обязательно	`string`	Дата и время последнего изменения в UTC. date-time
`deletedAt` Обязательно	`string \| null`	Дата удаления; null для действующего комментария. date-time
`version` Обязательно	`integer`	Текущая версия ресурса; обязательна для изменения. Минимум: 1
`mentions` Обязательно	`array<CommentMention>`	Непересекающиеся @упоминания участников. При изменении body без mentions очищаются; при запросе только с version сохраняются. Максимум элементов: 100. Элементы: CommentMention
`sourceClient` Необязательно	`string \| null`	Название MCP-клиента, назначенное сервером. null для обычного пользовательского или REST-комментария. Максимальная длина: 100

Дополнительные поля запрещены.

Демонстрационный ответ

{
  "id": "00000000-0000-4000-8000-000000000001",
  "workspaceId": "00000000-0000-4000-8000-000000000001",
  "issueId": "00000000-0000-4000-8000-000000000001",
  "authorId": "00000000-0000-4000-8000-000000000001",
  "authorName": "Пример",
  "body": "Комментарий через API",
  "createdAt": "2026-09-30T10:00:00Z",
  "updatedAt": "2026-09-30T10:00:00Z",
  "deletedAt": null,
  "version": 1,
  "mentions": [],
  "sourceClient": null
}

GET/workspaces/{workspaceId}/issues/{issueId}/comments/{commentId}Ссылка

Получить комментарий

Возвращает комментарий, автора, упоминания, версию и отметку удаления. У удалённого комментария body пустой; deletedAt заполнено.

Разрешения: comments:read. operationId: getComment

Параметры

Параметр	Где / тип	Описание
`workspaceId` Обязательно	path · `string`	UUID пространства, к которому привязан токен. uuid
`issueId` Обязательно	path · `string`	UUID ресурса в указанном пространстве. uuid
`commentId` Обязательно	path · `string`	UUID ресурса в указанном пространстве. uuid

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

curl --request GET "$PMLY_API/workspaces/$WORKSPACE_ID/issues/$ISSUE_ID/comments/$COMMENT_ID" \
  --header "Authorization: Bearer $PMLY_API_TOKEN"

Ответы

HTTP	Схема	Описание
`200`	`Comment`	Успешный запрос Заголовки: X-Request-Id
`400`	`Error`	Неверные параметры или тело запроса
`401`	`Error`	Токен отсутствует, истёк или отозван Заголовки: WWW-Authenticate
`403`	`Error`	Недостаточно разрешений или бизнес-прав
`404`	`Error`	Ресурс не найден или недоступен в этом пространстве
`409`	`Error`	Конфликт версии или ключа идемпотентности
`413`	`Error`	Тело запроса слишком велико
`429`	`Error`	Лимит запросов; подождите Retry-After секунд Заголовки: Retry-After
`500`	`Error`	Internal error

Схема и пример ответа 200

Поле	Тип	Описание
`id` Обязательно	`string`	Постоянный UUID ресурса. uuid
`workspaceId` Обязательно	`string`	UUID пространства, к которому привязан токен. uuid
`issueId` Обязательно	`string`	uuid
`authorId` Обязательно	`string`	UUID автора. uuid
`authorName` Обязательно	`string`	Имя автора.
`body` Обязательно	`string`	Текст комментария; пробелы по краям удаляются. У удалённого комментария текст пустой. Максимальная длина: 20000
`createdAt` Обязательно	`string`	Дата и время создания в UTC. date-time
`updatedAt` Обязательно	`string`	Дата и время последнего изменения в UTC. date-time
`deletedAt` Обязательно	`string \| null`	Дата удаления; null для действующего комментария. date-time
`version` Обязательно	`integer`	Текущая версия ресурса; обязательна для изменения. Минимум: 1
`mentions` Обязательно	`array<CommentMention>`	Непересекающиеся @упоминания участников. При изменении body без mentions очищаются; при запросе только с version сохраняются. Максимум элементов: 100. Элементы: CommentMention
`sourceClient` Необязательно	`string \| null`	Название MCP-клиента, назначенное сервером. null для обычного пользовательского или REST-комментария. Максимальная длина: 100

Дополнительные поля запрещены.

Демонстрационный ответ

{
  "id": "00000000-0000-4000-8000-000000000001",
  "workspaceId": "00000000-0000-4000-8000-000000000001",
  "issueId": "00000000-0000-4000-8000-000000000001",
  "authorId": "00000000-0000-4000-8000-000000000001",
  "authorName": "Пример",
  "body": "Комментарий через API",
  "createdAt": "2026-09-30T10:00:00Z",
  "updatedAt": "2026-09-30T10:00:00Z",
  "deletedAt": null,
  "version": 1,
  "mentions": [],
  "sourceClient": null
}

PATCH/workspaces/{workspaceId}/issues/{issueId}/comments/{commentId}Ссылка

Изменить комментарий

Меняет комментарий с проверкой version и прав автора/владельца пространства. При изменении body без mentions упоминания очищаются; при передаче только version сохраняются.

Разрешения: comments:write. operationId: updateComment

Параметры

Параметр	Где / тип	Описание
`workspaceId` Обязательно	path · `string`	UUID пространства, к которому привязан токен. uuid
`issueId` Обязательно	path · `string`	UUID ресурса в указанном пространстве. uuid
`commentId` Обязательно	path · `string`	UUID ресурса в указанном пространстве. uuid

Тело запроса

Content-Type: application/json · обязательно

Поле	Тип	Описание
`version` Обязательно	`integer`	Текущая версия ресурса; обязательна для изменения. Минимум: 1
`body` Необязательно	`string`	Текст комментария; пробелы по краям удаляются. У удалённого комментария текст пустой. Минимальная длина: 1. Максимальная длина: 20000
`mentions` Необязательно	`array<CommentMention>`	Непересекающиеся @упоминания участников. При изменении body без mentions очищаются; при запросе только с version сохраняются. Максимум элементов: 100. Элементы: CommentMention

Дополнительные поля запрещены.

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

curl --request PATCH "$PMLY_API/workspaces/$WORKSPACE_ID/issues/$ISSUE_ID/comments/$COMMENT_ID" \
  --header "Authorization: Bearer $PMLY_API_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
  "version": 1,
  "body": "Обновлённый комментарий"
}'

Ответы

HTTP	Схема	Описание
`200`	`Comment`	Успешный запрос Заголовки: X-Request-Id
`400`	`Error`	Неверные параметры или тело запроса
`401`	`Error`	Токен отсутствует, истёк или отозван Заголовки: WWW-Authenticate
`403`	`Error`	Недостаточно разрешений или бизнес-прав
`404`	`Error`	Ресурс не найден или недоступен в этом пространстве
`409`	`Error`	Конфликт версии или ключа идемпотентности
`413`	`Error`	Тело запроса слишком велико
`429`	`Error`	Лимит запросов; подождите Retry-After секунд Заголовки: Retry-After
`500`	`Error`	Internal error

Схема и пример ответа 200

Поле	Тип	Описание
`id` Обязательно	`string`	Постоянный UUID ресурса. uuid
`workspaceId` Обязательно	`string`	UUID пространства, к которому привязан токен. uuid
`issueId` Обязательно	`string`	uuid
`authorId` Обязательно	`string`	UUID автора. uuid
`authorName` Обязательно	`string`	Имя автора.
`body` Обязательно	`string`	Текст комментария; пробелы по краям удаляются. У удалённого комментария текст пустой. Максимальная длина: 20000
`createdAt` Обязательно	`string`	Дата и время создания в UTC. date-time
`updatedAt` Обязательно	`string`	Дата и время последнего изменения в UTC. date-time
`deletedAt` Обязательно	`string \| null`	Дата удаления; null для действующего комментария. date-time
`version` Обязательно	`integer`	Текущая версия ресурса; обязательна для изменения. Минимум: 1
`mentions` Обязательно	`array<CommentMention>`	Непересекающиеся @упоминания участников. При изменении body без mentions очищаются; при запросе только с version сохраняются. Максимум элементов: 100. Элементы: CommentMention
`sourceClient` Необязательно	`string \| null`	Название MCP-клиента, назначенное сервером. null для обычного пользовательского или REST-комментария. Максимальная длина: 100

Дополнительные поля запрещены.

Демонстрационный ответ

{
  "id": "00000000-0000-4000-8000-000000000001",
  "workspaceId": "00000000-0000-4000-8000-000000000001",
  "issueId": "00000000-0000-4000-8000-000000000001",
  "authorId": "00000000-0000-4000-8000-000000000001",
  "authorName": "Пример",
  "body": "Комментарий через API",
  "createdAt": "2026-09-30T10:00:00Z",
  "updatedAt": "2026-09-30T10:00:00Z",
  "deletedAt": null,
  "version": 1,
  "mentions": [],
  "sourceClient": null
}

DELETE/workspaces/{workspaceId}/issues/{issueId}/comments/{commentId}Ссылка

Удалить комментарий

Удаляет текст комментария с проверкой version из query-параметра и прав автора/владельца пространства. Метаданные остаются; успех — 204 без тела.

Разрешения: comments:write. operationId: deleteComment

Параметры

Параметр	Где / тип	Описание
`workspaceId` Обязательно	path · `string`	UUID пространства, к которому привязан токен. uuid
`issueId` Обязательно	path · `string`	UUID ресурса в указанном пространстве. uuid
`commentId` Обязательно	path · `string`	UUID ресурса в указанном пространстве. uuid
`version` Обязательно	query · `integer`	Текущая версия ресурса; обязательна для изменения. Минимум: 1

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

curl --request DELETE "$PMLY_API/workspaces/$WORKSPACE_ID/issues/$ISSUE_ID/comments/$COMMENT_ID?version=$VERSION" \
  --header "Authorization: Bearer $PMLY_API_TOKEN"

Ответы

HTTP	Схема	Описание
`204`	Без тела	Успешное удаление, без тела Заголовки: X-Request-Id
`400`	`Error`	Неверные параметры или тело запроса
`401`	`Error`	Токен отсутствует, истёк или отозван Заголовки: WWW-Authenticate
`403`	`Error`	Недостаточно разрешений или бизнес-прав
`404`	`Error`	Ресурс не найден или недоступен в этом пространстве
`409`	`Error`	Конфликт версии или ключа идемпотентности
`413`	`Error`	Тело запроса слишком велико
`429`	`Error`	Лимит запросов; подождите Retry-After секунд Заголовки: Retry-After
`500`	`Error`	Internal error

GET/workspaces/{workspaceId}/issues/{issueId}/activityСсылка

История задачи

Возвращает страницу истории задачи с автором, видом изменения и изменёнными значениями. Запись изменения и истории выполняется атомарно.

Разрешения: issues:read. operationId: listIssueActivity

Параметры

Параметр	Где / тип	Описание
`workspaceId` Обязательно	path · `string`	UUID пространства, к которому привязан токен. uuid
`issueId` Обязательно	path · `string`	UUID ресурса в указанном пространстве. uuid
`limit` Необязательно	query · `integer`	Размер страницы. По умолчанию: 50. Минимум: 1. Максимум: 100
`offset` Необязательно	query · `integer`	Количество пропущенных ресурсов. По умолчанию: 0. Минимум: 0. Максимум: 100000

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

curl --request GET "$PMLY_API/workspaces/$WORKSPACE_ID/issues/$ISSUE_ID/activity" \
  --header "Authorization: Bearer $PMLY_API_TOKEN"

Ответы

HTTP	Схема	Описание
`200`	`ActivityPage`	Успешный запрос Заголовки: X-Request-Id
`400`	`Error`	Неверные параметры или тело запроса
`401`	`Error`	Токен отсутствует, истёк или отозван Заголовки: WWW-Authenticate
`403`	`Error`	Недостаточно разрешений или бизнес-прав
`404`	`Error`	Ресурс не найден или недоступен в этом пространстве
`409`	`Error`	Конфликт версии или ключа идемпотентности
`413`	`Error`	Тело запроса слишком велико
`429`	`Error`	Лимит запросов; подождите Retry-After секунд Заголовки: Retry-After
`500`	`Error`	Internal error

Схема и пример ответа 200

Поле	Тип	Описание
`items` Обязательно	`array<Activity>`	Ресурсы текущей страницы. Элементы: Activity
`total` Обязательно	`integer`	Общее количество ресурсов, соответствующих запросу. Минимум: 0
`limit` Обязательно	`integer`	Размер страницы. Минимум: 1. Максимум: 100
`offset` Обязательно	`integer`	Количество пропущенных ресурсов. Минимум: 0. Максимум: 100000

Дополнительные поля запрещены.

Демонстрационный ответ

{
  "items": [
    {
      "id": "00000000-0000-4000-8000-000000000001",
      "actorId": "00000000-0000-4000-8000-000000000001",
      "actorName": "Пример",
      "kind": "Пример",
      "changes": {},
      "createdAt": "2026-09-30T10:00:00Z"
    }
  ],
  "total": 0,
  "limit": 1,
  "offset": 0
}

Схемы данных

Ссылки в таблицах ведут к полному описанию вложенных объектов.

Error

Поле	Тип	Описание
`code` Обязательно	`string`	Машиночитаемый код ошибки.
`message` Обязательно	`string`	Описание ошибки.
`requestId` Обязательно	`string`	UUID запроса; также возвращается в X-Request-Id. uuid

Дополнительные поля запрещены.

Workspace

Поле	Тип	Описание
`id` Обязательно	`string`	Постоянный UUID ресурса. uuid
`name` Обязательно	`string`	Название ресурса.
`role` Обязательно	`string`	Роль участника: OWNER или MEMBER. Значения: "OWNER", "MEMBER"

Дополнительные поля запрещены.

Team

Поле	Тип	Описание
`id` Обязательно	`string`	Постоянный UUID ресурса. uuid
`workspaceId` Обязательно	`string`	UUID пространства, к которому привязан токен. uuid
`name` Обязательно	`string`	Название ресурса.
`key` Обязательно	`string`	Ключ команды, используемый в отображаемых номерах задач.

Дополнительные поля запрещены.

Status

Поле	Тип	Описание
`id` Обязательно	`string`	Постоянный UUID ресурса. uuid
`teamId` Обязательно	`string`	UUID команды ресурса. uuid
`label` Обязательно	`string`	Название статуса.
`category` Обязательно	`string`	Категория статуса. Значения: "backlog", "unstarted", "started", "completed", "canceled"
`order` Обязательно	`integer`	Порядок статуса в команде.
`defaultStatus` Обязательно	`boolean`	Является ли статус начальным для команды.

Дополнительные поля запрещены.

Member

Поле	Тип	Описание
`userId` Обязательно	`string`	UUID пользователя. uuid
`displayName` Обязательно	`string \| null`	Отображаемое имя пользователя.
`role` Обязательно	`string`	Роль участника: OWNER или MEMBER. Значения: "OWNER", "MEMBER"

Дополнительные поля запрещены.

Context

Поле	Тип	Описание
`user` Обязательно	`object`	Пользователь, от имени которого действует токен.
`workspace` Обязательно	`Workspace`	Пространство токена и текущая роль пользователя.
`scopes` Обязательно	`array<string>`	Разрешения токена. Элементы: string
`expiresAt` Обязательно	`string`	Дата и время истечения токена. date-time

Дополнительные поля запрещены.

Вложенные поля user

Поле	Тип	Описание
`id` Обязательно	`string`	uuid
`displayName` Обязательно	`string \| null`

Дополнительные поля запрещены.

Issue

Поле	Тип	Описание
`id` Обязательно	`string`	Постоянный UUID ресурса. uuid
`workspaceId` Обязательно	`string`	UUID пространства, к которому привязан токен. uuid
`teamId` Обязательно	`string`	UUID команды ресурса. uuid
`projectId` Обязательно	`string \| null`	UUID проекта. null означает отсутствие проекта. uuid
`statusId` Обязательно	`string`	UUID статуса команды задачи. uuid
`assigneeId` Обязательно	`string \| null`	UUID активного участника. null снимает назначение. uuid
`number` Обязательно	`integer`	Номер задачи, назначенный сервером; уникален в команде. Минимум: 1
`identifier` Обязательно	`string`	Отображаемый ID задачи, например API-1.
`title` Обязательно	`string`	Название задачи. Минимальная длина: 1. Максимальная длина: 200
`description` Обязательно	`string`	Описание. Пустая строка очищает текст. Максимальная длина: 20000
`priority` Обязательно	`integer`	Приоритет: 0 — без приоритета, 1 — срочный, 2 — высокий, 3 — средний, 4 — низкий. Минимум: 0. Максимум: 4
`version` Обязательно	`integer`	Текущая версия ресурса; обязательна для изменения. Минимум: 1
`createdAt` Обязательно	`string`	Дата и время создания в UTC. date-time
`updatedAt` Обязательно	`string`	Дата и время последнего изменения в UTC. date-time
`cycleId` Обязательно	`string \| null`	UUID цикла команды. null снимает цикл. uuid

Дополнительные поля запрещены.

Project

Поле	Тип	Описание
`id` Обязательно	`string`	Постоянный UUID ресурса. uuid
`teamId` Обязательно	`string`	UUID команды ресурса. uuid
`name` Обязательно	`string`	Название ресурса. Минимальная длина: 1. Максимальная длина: 100
`description` Обязательно	`string`	Описание. Пустая строка очищает текст. Максимальная длина: 20000
`version` Обязательно	`integer`	Текущая версия ресурса; обязательна для изменения. Минимум: 1

Дополнительные поля запрещены.

Cycle

Поле	Тип	Описание
`id` Обязательно	`string`	Постоянный UUID ресурса. uuid
`workspaceId` Обязательно	`string`	UUID пространства, к которому привязан токен. uuid
`teamId` Обязательно	`string`	UUID команды ресурса. uuid
`name` Обязательно	`string`	Название ресурса. Минимальная длина: 1. Максимальная длина: 100
`startDate` Обязательно	`string`	Дата начала цикла, YYYY-MM-DD. date
`endDate` Обязательно	`string`	Дата окончания цикла, YYYY-MM-DD. date
`state` Обязательно	`string`	Состояние цикла. Значения: "open", "completed"
`version` Обязательно	`integer`	Текущая версия ресурса; обязательна для изменения. Минимум: 1

Дополнительные поля запрещены.

ViewSettings

Поле	Тип	Описание
`q` Необязательно	`string`	Вхождение в название или точный отображаемый ID задачи.
`projectId` Необязательно	`array<string>`	Выбранные значения фильтра. Значения одного поля — OR, разные поля — AND. Максимум элементов: 100. Элементы: string
`statusId` Необязательно	`array<string>`	Выбранные значения фильтра. Значения одного поля — OR, разные поля — AND. Максимум элементов: 100. Элементы: string
`assigneeId` Необязательно	`array<string>`	Выбранные значения фильтра. Значения одного поля — OR, разные поля — AND. Максимум элементов: 100. Элементы: string
`cycleId` Необязательно	`array<string>`	Выбранные значения фильтра. Значения одного поля — OR, разные поля — AND. Максимум элементов: 100. Элементы: string
`category` Необязательно	`array<string>`	Выбранные значения фильтра. Значения одного поля — OR, разные поля — AND. Максимум элементов: 100. Элементы: string
`priority` Необязательно	`array<integer>`	Выбранные значения фильтра. Значения одного поля — OR, разные поля — AND. Максимум элементов: 100. Элементы: integer. Минимум: 0. Максимум: 4
`groupBy` Необязательно	`string`	Поле группировки. Значения: "none", "status", "priority", "assignee", "project", "cycle"
`sortBy` Необязательно	`string`	Поле сортировки. Значения: "createdAt", "updatedAt", "priority"
`sortDirection` Необязательно	`string`	Направление сортировки. Значения: "asc", "desc"

Дополнительные поля запрещены.

View

Поле	Тип	Описание
`id` Обязательно	`string`	Постоянный UUID ресурса. uuid
`workspaceId` Обязательно	`string`	UUID пространства, к которому привязан токен. uuid
`authorId` Обязательно	`string`	UUID автора. uuid
`name` Обязательно	`string`	Название ресурса. Минимальная длина: 1. Максимальная длина: 100
`settings` Обязательно	`ViewSettings`	Фильтры и отображение представления. При PATCH переданный объект заменяется целиком.
`version` Обязательно	`integer`	Текущая версия ресурса; обязательна для изменения. Минимум: 1

Дополнительные поля запрещены.

Comment

Поле	Тип	Описание
`id` Обязательно	`string`	Постоянный UUID ресурса. uuid
`workspaceId` Обязательно	`string`	UUID пространства, к которому привязан токен. uuid
`issueId` Обязательно	`string`	uuid
`authorId` Обязательно	`string`	UUID автора. uuid
`authorName` Обязательно	`string`	Имя автора.
`body` Обязательно	`string`	Текст комментария; пробелы по краям удаляются. У удалённого комментария текст пустой. Максимальная длина: 20000
`createdAt` Обязательно	`string`	Дата и время создания в UTC. date-time
`updatedAt` Обязательно	`string`	Дата и время последнего изменения в UTC. date-time
`deletedAt` Обязательно	`string \| null`	Дата удаления; null для действующего комментария. date-time
`version` Обязательно	`integer`	Текущая версия ресурса; обязательна для изменения. Минимум: 1
`mentions` Обязательно	`array<CommentMention>`	Непересекающиеся @упоминания участников. При изменении body без mentions очищаются; при запросе только с version сохраняются. Максимум элементов: 100. Элементы: CommentMention
`sourceClient` Необязательно	`string \| null`	Название MCP-клиента, назначенное сервером. null для обычного пользовательского или REST-комментария. Максимальная длина: 100

Дополнительные поля запрещены.

Activity

Поле	Тип	Описание
`id` Обязательно	`string`	Постоянный UUID ресурса. uuid
`actorId` Обязательно	`string`	UUID автора изменения. uuid
`actorName` Обязательно	`string`	Имя автора изменения.
`kind` Обязательно	`string`	Вид события истории.
`changes` Обязательно	`object`	Изменённые поля и значения.
`createdAt` Обязательно	`string`	Дата и время создания в UTC. date-time

Дополнительные поля запрещены.

WorkspacePage

Поле	Тип	Описание
`items` Обязательно	`array<Workspace>`	Ресурсы текущей страницы. Элементы: Workspace
`total` Обязательно	`integer`	Общее количество ресурсов, соответствующих запросу. Минимум: 0
`limit` Обязательно	`integer`	Размер страницы. Минимум: 1. Максимум: 100
`offset` Обязательно	`integer`	Количество пропущенных ресурсов. Минимум: 0. Максимум: 100000

Дополнительные поля запрещены.

TeamPage

Поле	Тип	Описание
`items` Обязательно	`array<Team>`	Ресурсы текущей страницы. Элементы: Team
`total` Обязательно	`integer`	Общее количество ресурсов, соответствующих запросу. Минимум: 0
`limit` Обязательно	`integer`	Размер страницы. Минимум: 1. Максимум: 100
`offset` Обязательно	`integer`	Количество пропущенных ресурсов. Минимум: 0. Максимум: 100000

Дополнительные поля запрещены.

StatusPage

Поле	Тип	Описание
`items` Обязательно	`array<Status>`	Ресурсы текущей страницы. Элементы: Status
`total` Обязательно	`integer`	Общее количество ресурсов, соответствующих запросу. Минимум: 0
`limit` Обязательно	`integer`	Размер страницы. Минимум: 1. Максимум: 100
`offset` Обязательно	`integer`	Количество пропущенных ресурсов. Минимум: 0. Максимум: 100000

Дополнительные поля запрещены.

MemberPage

Поле	Тип	Описание
`items` Обязательно	`array<Member>`	Ресурсы текущей страницы. Элементы: Member
`total` Обязательно	`integer`	Общее количество ресурсов, соответствующих запросу. Минимум: 0
`limit` Обязательно	`integer`	Размер страницы. Минимум: 1. Максимум: 100
`offset` Обязательно	`integer`	Количество пропущенных ресурсов. Минимум: 0. Максимум: 100000

Дополнительные поля запрещены.

IssuePage

Поле	Тип	Описание
`items` Обязательно	`array<Issue>`	Ресурсы текущей страницы. Элементы: Issue
`total` Обязательно	`integer`	Общее количество ресурсов, соответствующих запросу. Минимум: 0
`limit` Обязательно	`integer`	Размер страницы. Минимум: 1. Максимум: 100
`offset` Обязательно	`integer`	Количество пропущенных ресурсов. Минимум: 0. Максимум: 100000

Дополнительные поля запрещены.

ProjectPage

Поле	Тип	Описание
`items` Обязательно	`array<Project>`	Ресурсы текущей страницы. Элементы: Project
`total` Обязательно	`integer`	Общее количество ресурсов, соответствующих запросу. Минимум: 0
`limit` Обязательно	`integer`	Размер страницы. Минимум: 1. Максимум: 100
`offset` Обязательно	`integer`	Количество пропущенных ресурсов. Минимум: 0. Максимум: 100000

Дополнительные поля запрещены.

CyclePage

Поле	Тип	Описание
`items` Обязательно	`array<Cycle>`	Ресурсы текущей страницы. Элементы: Cycle
`total` Обязательно	`integer`	Общее количество ресурсов, соответствующих запросу. Минимум: 0
`limit` Обязательно	`integer`	Размер страницы. Минимум: 1. Максимум: 100
`offset` Обязательно	`integer`	Количество пропущенных ресурсов. Минимум: 0. Максимум: 100000

Дополнительные поля запрещены.

ViewPage

Поле	Тип	Описание
`items` Обязательно	`array<View>`	Ресурсы текущей страницы. Элементы: View
`total` Обязательно	`integer`	Общее количество ресурсов, соответствующих запросу. Минимум: 0
`limit` Обязательно	`integer`	Размер страницы. Минимум: 1. Максимум: 100
`offset` Обязательно	`integer`	Количество пропущенных ресурсов. Минимум: 0. Максимум: 100000

Дополнительные поля запрещены.

CommentPage

Поле	Тип	Описание
`items` Обязательно	`array<Comment>`	Ресурсы текущей страницы. Элементы: Comment
`total` Обязательно	`integer`	Общее количество ресурсов, соответствующих запросу. Минимум: 0
`limit` Обязательно	`integer`	Размер страницы. Минимум: 1. Максимум: 100
`offset` Обязательно	`integer`	Количество пропущенных ресурсов. Минимум: 0. Максимум: 100000

Дополнительные поля запрещены.

ActivityPage

Поле	Тип	Описание
`items` Обязательно	`array<Activity>`	Ресурсы текущей страницы. Элементы: Activity
`total` Обязательно	`integer`	Общее количество ресурсов, соответствующих запросу. Минимум: 0
`limit` Обязательно	`integer`	Размер страницы. Минимум: 1. Максимум: 100
`offset` Обязательно	`integer`	Количество пропущенных ресурсов. Минимум: 0. Максимум: 100000

Дополнительные поля запрещены.

CreateIssue

Поле	Тип	Описание
`teamId` Обязательно	`string`	UUID команды ресурса. uuid
`projectId` Необязательно	`string \| null`	UUID проекта. null означает отсутствие проекта. uuid
`statusId` Необязательно	`string`	UUID статуса команды задачи. uuid
`assigneeId` Необязательно	`string \| null`	UUID активного участника. null снимает назначение. uuid
`title` Обязательно	`string`	Название задачи. Минимальная длина: 1. Максимальная длина: 200
`description` Необязательно	`string`	Описание. Пустая строка очищает текст. Максимальная длина: 20000
`priority` Необязательно	`integer`	Приоритет: 0 — без приоритета, 1 — срочный, 2 — высокий, 3 — средний, 4 — низкий. Минимум: 0. Максимум: 4
`cycleId` Необязательно	`string \| null`	UUID цикла команды. null снимает цикл. uuid

Дополнительные поля запрещены.

UpdateIssue

Поле	Тип	Описание
`version` Обязательно	`integer`	Текущая версия ресурса; обязательна для изменения. Минимум: 1
`projectId` Необязательно	`string \| null`	UUID проекта. null означает отсутствие проекта. uuid
`statusId` Необязательно	`string`	UUID статуса команды задачи. uuid
`assigneeId` Необязательно	`string \| null`	UUID активного участника. null снимает назначение. uuid
`title` Необязательно	`string`	Название задачи. Минимальная длина: 1. Максимальная длина: 200
`description` Необязательно	`string`	Описание. Пустая строка очищает текст. Максимальная длина: 20000
`priority` Необязательно	`integer`	Приоритет: 0 — без приоритета, 1 — срочный, 2 — высокий, 3 — средний, 4 — низкий. Минимум: 0. Максимум: 4
`cycleId` Необязательно	`string \| null`	UUID цикла команды. null снимает цикл. uuid

Дополнительные поля запрещены.

CreateProject

Поле	Тип	Описание
`teamId` Обязательно	`string`	UUID команды ресурса. uuid
`name` Обязательно	`string`	Название ресурса. Минимальная длина: 1. Максимальная длина: 100
`description` Необязательно	`string`	Описание. Пустая строка очищает текст. Максимальная длина: 20000

Дополнительные поля запрещены.

UpdateProject

Поле	Тип	Описание
`version` Обязательно	`integer`	Текущая версия ресурса; обязательна для изменения. Минимум: 1
`name` Необязательно	`string`	Название ресурса. Минимальная длина: 1. Максимальная длина: 100
`description` Необязательно	`string`	Описание. Пустая строка очищает текст. Максимальная длина: 20000

Дополнительные поля запрещены.

CreateCycle

Поле	Тип	Описание
`teamId` Обязательно	`string`	UUID команды ресурса. uuid
`name` Обязательно	`string`	Название ресурса. Минимальная длина: 1. Максимальная длина: 100
`startDate` Обязательно	`string`	Дата начала цикла, YYYY-MM-DD. date
`endDate` Обязательно	`string`	Дата окончания цикла, YYYY-MM-DD. date

Дополнительные поля запрещены.

UpdateCycle

Поле	Тип	Описание
`version` Обязательно	`integer`	Текущая версия ресурса; обязательна для изменения. Минимум: 1
`name` Необязательно	`string`	Название ресурса. Минимальная длина: 1. Максимальная длина: 100
`startDate` Необязательно	`string`	Дата начала цикла, YYYY-MM-DD. date
`endDate` Необязательно	`string`	Дата окончания цикла, YYYY-MM-DD. date

Дополнительные поля запрещены.

CompleteCycle

Поле	Тип	Описание
`version` Обязательно	`integer`	Текущая версия ресурса; обязательна для изменения. Минимум: 1

Дополнительные поля запрещены.

CreateView

Поле	Тип	Описание
`name` Обязательно	`string`	Название ресурса. Минимальная длина: 1. Максимальная длина: 100
`settings` Обязательно	`ViewSettings`	Фильтры и отображение представления. При PATCH переданный объект заменяется целиком.

Дополнительные поля запрещены.

UpdateView

Поле	Тип	Описание
`version` Обязательно	`integer`	Текущая версия ресурса; обязательна для изменения. Минимум: 1
`name` Необязательно	`string`	Название ресурса. Минимальная длина: 1. Максимальная длина: 100
`settings` Необязательно	`ViewSettings`	Фильтры и отображение представления. При PATCH переданный объект заменяется целиком.

Дополнительные поля запрещены.

CreateComment

Поле	Тип	Описание
`body` Обязательно	`string`	Текст комментария; пробелы по краям удаляются. У удалённого комментария текст пустой. Минимальная длина: 1. Максимальная длина: 20000
`mentions` Необязательно	`array<CommentMention>`	Непересекающиеся @упоминания участников. При изменении body без mentions очищаются; при запросе только с version сохраняются. Максимум элементов: 100. Элементы: CommentMention

Дополнительные поля запрещены.

UpdateComment

Поле	Тип	Описание
`version` Обязательно	`integer`	Текущая версия ресурса; обязательна для изменения. Минимум: 1
`body` Необязательно	`string`	Текст комментария; пробелы по краям удаляются. У удалённого комментария текст пустой. Минимальная длина: 1. Максимальная длина: 20000
`mentions` Необязательно	`array<CommentMention>`	Непересекающиеся @упоминания участников. При изменении body без mentions очищаются; при запросе только с version сохраняются. Максимум элементов: 100. Элементы: CommentMention

Дополнительные поля запрещены.

CommentMention

Упоминание участника пространства. Смещения UTF-16 start включительно / end не включительно покрывают @имя в переданном body. В ответе смещения относятся к сохранённому тексту после удаления пробелов по краям.

Поле	Тип	Описание
`userId` Обязательно	`string`	UUID пользователя. uuid
`start` Обязательно	`integer`	Начало @упоминания включительно, в UTF-16 единицах. Минимум: 0
`end` Обязательно	`integer`	Конец @упоминания не включительно, в UTF-16 единицах. Минимум: 2

Дополнительные поля запрещены.