Yandex 360 Forms

---
name: yandex-360-forms
description: >-
  Use when reading or driving Yandex Forms through ycli — form schemas,
  responses, question CRUD, publishing, keysets, integrations, conditions,
  access — via the `ycli forms` CLI, the `forms_*` MCP tools, or the FormsClient
  SDK.
---
# Yandex 360 Forms

Drive Yandex Forms via `ycli` — reads **and writes** — through the CLI, the `forms_*` MCP tools, or the `FormsClient` SDK. Every documented Forms endpoint is wrapped; none needs raw HTTP.

## When to use

- Listing forms you can access, or inspecting one form's schema (questions, options, conditional logic)
- Reading or exporting form responses (answers)
- Creating a form, doing question CRUD, reordering questions, publishing/unpublishing
- Submitting a form programmatically (filling), managing keysets
- Integrations (hooks and their actions), display conditions, who may edit or fill a form, a form's change log, and the runs of its integrations (§4)
- Pre-flight before editing a form in the UI — confirm what's there and what to change

## When NOT to use

- Reading or editing Tracker issues — use `yandex-360-tracker`
- Reading or editing Wiki pages — use `yandex-360-wiki`
- Form appearance / themes, analytics / charts — UI-only

## Scope: reads vs. writes

You can **read** any form your token can access. You can **write** to any form you have permission on. Both ship on all three ycli surfaces:

- **CLI** — `uv run ycli forms <group> <cmd>` (full surface, including binary uploads/downloads)
- **MCP** — `forms_*` tools, reads and writes. Write tools carry honest annotations (`readOnlyHint=False`, explicit `destructiveHint`); `ycli mcp start --read-only` hides them. Binary payloads (files/images upload, keysets/exports download) are CLI/SDK-only.
- **SDK** — `from ycli.yandex.forms.client import FormsClient` → `FormsClient(oauth_token=…, organization_id=…)`

---

## 1. Auth and hosts

Public API (`api.forms.yandex.net`):

```text
Authorization: OAuth $YANDEX_ID_OAUTH_TOKEN
X-Org-Id: $YANDEX_ID_ORGANIZATION_ID
```

The OAuth token needs `forms:read` / `forms:write` scopes (see the auth section of the live API reference at <https://yandex.ru/dev/forms/>). The same token may work for Tracker/Wiki if those scopes were also granted, but Forms scopes are separate — a Tracker-only token will 401/403 here. The CLI/MCP/SDK set both headers for you from the environment.

**Host trap:** the base host is `api.forms.yandex.net` — NOT `api.tracker.yandex.net`. Only relevant if you drop to raw HTTP; ycli encodes it.

---

## 2. Reading

| Operation | CLI | MCP tool |
|-----------|-----|----------|
| Auth probe (current user) | `uv run ycli forms me get` | `forms_me_get` |
| List forms | `uv run ycli forms surveys list` | `forms_surveys_list` |
| Get form settings | `uv run ycli forms surveys get <form_id>` | `forms_surveys_get` |
| List questions (schema) | `uv run ycli forms questions list <form_id>` | `forms_questions_list` |
| Get one question | `uv run ycli forms questions get <form_id> <q_id>` | `forms_questions_get` |
| List answers (responses) | `uv run ycli forms answers list <form_id> [--all]` | `forms_answers_list` |
| Fillable form view (option ids!) | `uv run ycli forms filling get <form_id>` | `forms_filling_get` |
| Suggest values for a question | `uv run ycli forms filling suggest <form_id> --question <slug> --text …` | `forms_filling_suggest` |
| Keysets | `uv run ycli forms keysets list\|get …` | `forms_keysets_list` / `forms_keysets_get` |
| Verify uploaded file paths | `uv run ycli forms files verify <form_id> --path …` | `forms_files_verify` |
| Poll async operation | `uv run ycli forms operations get <op_id>` | `forms_operations_get` |
| Integrations run by one answer | `uv run ycli forms answers integrations-list --answer-id <id>` (or `--answer-key`) | `forms_answers_integrations_list` |

**Single-answer read:** `uv run ycli forms answers get --answer-id <id>` (or `--answer-key <hash>`, which works without form-edit access) — pass exactly one of the two. MCP: `forms_answers_get`. The live route is the flat query-param `GET /v1/answers?answer_id=…`; no survey id needed (the path variants 404).

### SDK example

```python
from ycli.yandex.forms.client import FormsClient

forms = FormsClient(oauth_token="…", organization_id="…")
forms.me.get()  # auth probe
forms.surveys.list()  # list forms
forms.surveys.get("<form_id>")  # form settings
forms.questions.list("<form_id>")  # schema
forms.answers.list("<form_id>")  # responses
```

---

## 3. Writing

All writes below are live-verified (2026-07-12) end-to-end via the CLI; each is also an MCP write tool and an SDK method.

### 3.1. Form (survey) lifecycle

```bash
uv run ycli forms surveys create --name "My form"          # → capture the returned id
uv run ycli forms surveys update <form_id> --name "New name"
uv run ycli forms surveys publish <form_id>                # is_published: true
uv run ycli forms surveys unpublish <form_id>
uv run ycli forms surveys delete <form_id>                 # destructive
```

MCP: `forms_surveys_create` / `forms_surveys_update` / `forms_surveys_publish` / `forms_surveys_unpublish` / `forms_surveys_delete`.

### 3.2. Question CRUD

```bash
uv run ycli forms questions create <form_id> --type string --label "Your feedback"
uv run ycli forms questions create <form_id> --body-file question.json   # full-body form (enum options, suggest, …)
uv run ycli forms questions update <form_id> <q_id> --type string --label "Your feedback (edited)"
uv run ycli forms questions move <form_id> <q_id> --page 1 --position 1
uv run ycli forms questions delete <form_id> <q_id>
```

MCP: `forms_questions_create` / `forms_questions_update` / `forms_questions_move` / `forms_questions_delete`.

### 3.3. Submit a response (filling)

```bash
uv run ycli forms filling get <form_id>                                  # exposes the enum option ids
uv run ycli forms filling submit <form_id> --body-file answer-body.json  # --validate-only checks without saving
```

MCP: `forms_filling_submit`. The form must be published (`is_published: true`) or the submit is rejected.

### 3.4. Keysets

```bash
uv run ycli forms keysets create <form_id> --name my-keyset --total 3 --enabled
uv run ycli forms keysets update <form_id> <keyset_id> --name renamed --total 5 --disabled
uv run ycli forms keysets download <form_id> <keyset_id> --output keys.xlsx   # binary — CLI/SDK only
uv run ycli forms keysets delete <form_id> <keyset_id>
```

MCP: `forms_keysets_create` / `forms_keysets_update` / `forms_keysets_delete` (download is CLI/SDK-only).

### 3.5. Exports and binary operations

```bash
uv run ycli forms answers export <form_id> --format csv --wait --output export.csv
uv run ycli forms files upload <form_id> report.pdf        # form-filling file upload
uv run ycli forms images upload <form_id> logo.png
uv run ycli forms files download --path <storage_path> --output file.bin
uv run ycli forms files delete --path <storage_path>
```

```bash
uv run ycli forms images clone <form_id> --image-id <image_id> --name copy.png   # copy an uploaded image; returns the new one
uv run ycli forms answers delete <form_id> <answer_id>      # destructive
uv run ycli forms answers restore <form_id> <answer_id>
```

MCP: `forms_images_clone`, `forms_answers_delete`, `forms_answers_restore`. On the test organization the API answered `400 disabled` ("function is blocked") to answer delete and restore, so they are wrapped from the spec but not verified against a live form.

MCP note: `forms_answers_export` triggers the export and `forms_operations_get` polls it, but the **download** of the produced file — like every raw-bytes operation here (`files upload/download`, `images upload`, `keysets download`) — is CLI/SDK-only; MCP excludes raw binary payloads. `forms_files_delete` (destructive) and `forms_files_verify` are on MCP.

---

## 4. Integrations, conditions, access, history

All of this ships on the CLI, MCP and SDK; `--help` on any group lists its commands.

| Task | CLI | MCP tool |
|------|-----|----------|
| Integration groups (hooks) | `forms hooks list\|get\|create\|update\|delete <form_id> …` | `forms_hooks_*` |
| Actions of a group (Tracker issue, Wiki page, email, HTTP, JSON-RPC, cloud function) | `forms subscriptions list\|get\|create\|update\|delete <form_id> <hook_id> …` (`create`/`update` take `--body-file`; `type` picks the action) | `forms_subscriptions_*` |
| Upload a fixed attachment for an action | `forms subscriptions attach …` | CLI/SDK only (binary) |
| Variables an action can reference | `forms variables list <form_id>` | `forms_variables_list` |
| Show conditions of a question, page, submit button | `forms conditions question\|page\|submit list\|get\|create\|update\|delete\|update-operator …` | `forms_conditions_question_*`, `_page_*`, `_submit_*` |
| Conditions gating an integration group | `forms conditions hook list\|get\|create\|update\|delete\|update-operator <form_id> <hook_id> …` | `forms_conditions_hook_*` |
| Who may edit (`change`) or fill (`submit`) | `forms access list\|set\|grant\|revoke <form_id> …` | `forms_access_*` |
| A form's change log | `forms history list <form_id> [--ordering asc\|desc] [--all]` | `forms_history_list` |
| Integration runs (filter by form, group, action, answer, status, time) | `forms notifications list [--survey-id …] [--status error]` | `forms_notifications_list` |
| One run in full / its state | `forms notifications get\|status-get <notification_id>` | `forms_notifications_get` / `_status_get` |
| Retry or stop a run | `forms notifications restart\|cancel <notification_id>` | `forms_notifications_restart` / `_cancel` |
| Ids of a form's failed runs | `forms notifications errors-list <form_id>` | `forms_notifications_errors_list` |

```bash
uv run ycli forms hooks create <form_id> --name CRM --active          # → hook id
uv run ycli forms subscriptions create <form_id> <hook_id> --body-file action.json
uv run ycli forms conditions hook create <form_id> <hook_id> --operator and \
  --item '{"type": "question", "condition": "eq", "question": "q1", "value": "yes"}'
uv run ycli forms access update <form_id> --action submit --access restricted
uv run ycli forms access grant <form_id> --action submit --uid <uid>
```

After an integration change, submit a test response, then check `forms notifications list --survey-id <form_id>` (and `forms notifications get <id>` for the error of a failed run) and the resulting Tracker issue / Wiki page / email.

## 5. Guardrails (live-verified quirks, 2026-07-12)

- **Enum answers in `filling submit` must be lists.** `{"answer_choices_<id>": ["<option_id>"]}` — a bare string 400s with `error_code: type`. Option ids come from `filling get`.
- **`questions move` needs `--page` with `--position`.** `--position` alone returns 200 but is a **silent no-op** — order unchanged.
- **`files upload` requires external storage.** Form-filling uploads 400 (`value_error.storage_error`) unless the org has connected its own S3 storage in the Forms UI settings — not API-toggleable.
- **`keysets update` sends the full record.** The PATCH requires every field, not a partial diff — the CLI enforces this.
- **Publish state matters.** Unpublished forms reject submits; check `is_published` via `surveys get`.
- **Question IDs are server-assigned.** Read them back from the create/list response; never hardcode.
- **Suggest questions:** valid `data_source` names are `city` / `country`; suggest text matching is language-sensitive (Cyrillic input matches Russian city names).
- **Access.** `access update` changes the level of one action (`owner`, `restricted`, `common`, `public`); `grant` and `revoke` take `--uid`/`--cloud-uid` or `--group-src` + `--group-id`. The owner cannot be revoked (`400 cannot revoke access from owner`); revoking someone who has no access changes nothing.
- **Notifications.** A run stays `pending` while the API retries it; `cancel` of a pending run answers `ok` and sets `canceled`, of a stopped one `skip`. `restart` of a pending run is skipped; of a canceled one it answers `operation` with `operation_id: "not-supported"` (nothing to poll) and the run returns to `pending`. `notifications list` pages by a `links.next` link; `errors` was still empty while the test runs were `pending`.
- **Images.** Forms answers `504` to an upload that is not a real image; use a PNG/JPEG.
- **OAuth scopes are separate.** A 401/403 usually means the token lacks `forms:read` / `forms:write`.
- **Org header is `X-Org-Id`** — the same canonical header every Yandex 360 service uses; HTTP header names are case-insensitive (RFC 9110), so a 422 is never a casing problem.
- **Datasource questions are scoped.** Tracker/Wiki/directory suggests are queue-/space-scoped — set the form's `dir_id` / target queue first.

---

## 6. References guide

| Resource | When to use |
|----------|-------------|
| `references/forms-api-quick-ref.md` | Bundled cheatsheet — host/auth, endpoint map, question types |
| <https://yandex.ru/dev/forms/> | Developer portal — full public API reference (auth, surveys, questions, answers, hooks, operations) |
| <https://yandex.ru/support/forms/> | Product docs — concepts, question types, integrations, publishing, conditions |