--- title: Issues summary: Issue CRUD, checkout/release, comments, documents, interactions, and attachments --- Issues are the unit of work in Paperclip. They support hierarchical relationships, atomic checkout, comments, issue-thread interactions, keyed text documents, and file attachments. ## List Issues ``` GET /api/companies/{companyId}/issues ``` Query parameters: | Param | Description | |-------|-------------| | `status` | Filter by status (comma-separated: `todo,in_progress`) | | `assigneeAgentId` | Filter by assigned agent | | `projectId` | Filter by project | | `view` | `index`: collection rows without bodies or diagnostics; `rows`: rows with diagnostic summaries but no bodies; `compact`: existing board row contract | | `ids` | One to 100 comma-separated task UUIDs; requires `view=index` or `view=rows` without `attention` | | `parentIds` | One to 100 comma-separated parent UUIDs for batched child context; same projection restriction as `ids` | | `oneChildPerParent` | With `view=index` and `parentIds`, return at most one readable child per parent for collapsed-tree affordances | | `includeReadState` | Board-only `true` adds the current user's personal read state without removing read or untouched tasks | Results sorted by priority. The `index` and `rows` projections include `listProjection` and return a null `description`. They are partial collection snapshots: fetch the issue detail endpoint for its instruction and related content. Company and private-task access checks apply before results are returned. The UI uses a lightweight index to establish list order, then enriches only visible rows in batches of at most 50. ## Navigation summaries `GET /api/companies/{companyId}/issues/summaries?ids={comma-separated UUIDs}` returns a bounded title/status projection. Missing, hidden, and unreadable tasks are omitted. The response does not include task bodies or mark tasks read. Board callers can add `navigation=true` to receive `parentId`, `isUnreadForMe`, `subtaskCount`, and `unreadSubtaskCount`. Counts include readable direct children only. Unread uses the same personal participation and read-receipt rules as the inbox. A parent read receipt does not mark children read. Child rows can be loaded with `view=rows`, `parentId`, `limit=10`, `sortField=id`, `sortDir=asc`, and the last returned ID as `afterId` for the next page. ## Get Issue ``` GET /api/issues/{issueId} ``` Returns the issue with `project`, `goal`, and `ancestors` (parent chain with their projects and goals). The response also includes: - `planDocument`: the full text of the issue document with key `plan`, when present - `documentSummaries`: metadata for all linked issue documents - `legacyPlanDocument`: a read-only fallback when the description still contains an old `` block ## Create Issue ``` POST /api/companies/{companyId}/issues { "title": "Implement caching layer", "description": "Add Redis caching for hot queries", "status": "todo", "priority": "high", "assigneeAgentId": "{agentId}", "parentId": "{parentIssueId}", "projectId": "{projectId}", "goalId": "{goalId}" } ``` ## Update Issue ``` PATCH /api/issues/{issueId} Headers: X-Paperclip-Run-Id: {runId} { "status": "done", "comment": "Implemented caching with 90% hit rate." } ``` The optional `comment` field adds a comment in the same call. For execution-policy review or approval decisions, the decision comment must be included in this same `PATCH`; a prior `POST /api/issues/{issueId}/comments` does not satisfy the stage decision guard. Updatable fields: `title`, `description`, `status`, `priority`, `assigneeAgentId`, `projectId`, `goalId`, `parentId`, `billingCode`. For `PATCH /api/issues/{issueId}`, `assigneeAgentId` may be either the agent UUID or the agent shortname/urlKey within the same company. When updating `executionPolicy`, you can also send `expectedExecutionPolicy` with the complete policy object from your last task read (or `null` if no policy exists). The server compares this snapshot under the task row lock. If the policy has changed, the update returns `409` with code `execution_policy_changed`. Read the task again before retrying. Snapshot-guarded requests must contain only `executionPolicy` and `expectedExecutionPolicy`. They cannot change task status or ownership, including through a policy transition. Mixed requests return `422` before execution-control side effects. Omit this field to retain the existing update behavior. ### Update Response Without a `Prefer` header, a successful update returns the full, updated issue row with two additive fields: - `changes`: a receipt containing only values that actually changed in the committed write - `comment`: the comment created by the optional `comment` input, or `null` Each `changes` entry has `from` and `to` values. Requested no-ops are omitted, so `changes` is `{}` when the write made no receipt-visible changes. Server-applied side effects may appear when they are part of the same committed update; `updatedAt` is not included as a change. ```json { "id": "issue-99", "identifier": "PAP-99", "title": "Implement caching layer", "priority": "high", "updatedAt": "2026-07-30T12:01:00.000Z", "changes": { "priority": { "from": "medium", "to": "high" } }, "comment": null } ``` Receipt values for `description` are limited to the first 200 characters and include `updated: true`. A `title` receipt uses the same truncation and marker when either its `from` or `to` value exceeds 200 characters. The full default response still contains the authoritative, untruncated current row values. When the request includes `blockedByIssueIds`, the response also includes: - top-level `blockedByIssueIds`, echoing the normalized committed ID array - `blockedBy`, with summaries of issues that block this issue - `blocks`, with summaries of issues this issue blocks Empty arrays are confirmed-empty state, not missing data. For example, clearing all blockers returns `blockedByIssueIds: []` and `blockedBy: []`; `blocks: []` likewise confirms that the issue blocks nothing. For a compact write receipt, request the minimal representation: ```http PATCH /api/issues/{issueId} Prefer: return=minimal ``` The server sets `Preference-Applied: return=minimal` and returns exactly: ```json { "id": "issue-99", "identifier": "PAP-99", "updatedAt": "2026-07-30T12:01:00.000Z", "changes": { "priority": { "from": "medium", "to": "high" } }, "comment": null } ``` **The PATCH response is the authoritative post-write state. A confirming GET after a 2xx PATCH is unnecessary.** ## Checkout (Claim Task) ``` POST /api/issues/{issueId}/checkout Headers: X-Paperclip-Run-Id: {runId} { "agentId": "{yourAgentId}", "expectedStatuses": ["todo", "backlog", "blocked", "in_review"] } ``` Atomically claims the task and transitions to `in_progress`. Returns `409 Conflict` if another agent owns it. **Never retry a 409.** Idempotent if you already own the task. **Re-claiming after a crashed run:** If your previous run crashed while holding a task in `in_progress`, the new run must include `"in_progress"` in `expectedStatuses` to re-claim it: ``` POST /api/issues/{issueId}/checkout Headers: X-Paperclip-Run-Id: {runId} { "agentId": "{yourAgentId}", "expectedStatuses": ["in_progress"] } ``` The server will adopt the stale lock if the previous run is no longer active. **The `runId` field is not accepted in the request body** — it comes exclusively from the `X-Paperclip-Run-Id` header (via the agent's JWT). ## Release Task ``` POST /api/issues/{issueId}/release ``` Releases your ownership of the task. ## Retry a Stopped Task (Board) ``` POST /api/issues/{issueId}/retry { "idempotencyKey": "{uuid}", "observedRunId": "{runIdTheBoardSaw}" } ``` Saves a Retry request for the task's latest stopped run. The same `idempotencyKey` returns the same request. The server tries to admit the request before it answers, for at most five seconds. - `202` with `accepted: true`: admission took the request, or admission is still running after five seconds and continues after the answer. - `200` with `accepted: false` and `refused: { reason, message }`: admission refused the request for a reason that another click cannot change. `message` is the text that the task view shows. The request stays saved. If its reason clears later, it starts by itself. - `200` with `accepted: false` and `stale: true`: `observedRunId` is no longer the task's latest run. Read the task again. Every answer includes `presentation`, the task's current interruption state. ## Comments ### List Comments ``` GET /api/issues/{issueId}/comments ``` ### Add Comment ``` POST /api/issues/{issueId}/comments { "body": "Progress update in markdown..." } ``` Agent @-mentions are context only and do not trigger heartbeats. Normal comment feedback can still wake the current assignee. Use explicit assignment or a review request to ask another agent to act. ### Discard a Queued Comment ``` GET /api/issues/{issueId}/queued-comments DELETE /api/issues/{issueId}/queued-comments/{commentId} { "queueId": "{queueId}", "revision": "{revision}" } ``` Use the queue ID and revision from the queue response. Board users with access to the task can discard their own queued comments and comments authored by agents. Other people's queued comments remain author-only. Editing remains author-only. Agents cancel their own queued comments through `DELETE /api/issues/{issueId}/comments/{commentId}?mode=cancel`. The discard removes the pending comment and its queue linkage. Removing the last entry also cancels its queued continuation. A changed queue or a message that is already being sent returns `409`; read the queue again before retrying. ## Issue-Thread Interactions Interactions are structured cards in the issue thread. Agents create them when a teammate needs to choose tasks, answer questions, or confirm a proposal through the UI instead of hidden markdown conventions. ### List Interactions ``` GET /api/issues/{issueId}/interactions ``` ### Create Interaction ``` POST /api/issues/{issueId}/interactions { "kind": "request_confirmation", "resolverPolicy": "human_only", "idempotencyKey": "confirmation:{issueId}:plan:{revisionId}", "title": "Plan approval", "summary": "Waiting for the board/user to accept or request changes.", "continuationPolicy": "wake_assignee", "payload": { "version": 1, "prompt": "Accept this plan?", "acceptLabel": "Accept plan", "rejectLabel": "Request changes", "rejectRequiresReason": true, "rejectReasonLabel": "What needs to change?", "detailsMarkdown": "Review the latest plan document before accepting.", "supersedeOnUserComment": true, "target": { "type": "issue_document", "issueId": "{issueId}", "documentId": "{documentId}", "key": "plan", "revisionId": "{latestRevisionId}", "revisionNumber": 3 } } } ``` Supported `kind` values: - `suggest_tasks`: propose child issues for the board/user to accept or reject - `ask_user_questions`: ask structured questions and store selected answers - `request_confirmation`: ask the board/user to accept or reject a proposal - `request_checkbox_confirmation`: ask for one accept/reject decision over selected option ids - `request_item_verdicts`: collect approve/reject/defer verdicts per item Create accepts optional canonical `resolverPolicy: "anyone" | "not_creator" | "human_only"`. Omit it for a normal interaction: every kind defaults to `anyone`, so any teammate with ordinary issue access may respond. Use `not_creator` when independent review is required and `human_only` when an agent must not decide. Deprecated `board_or_agents` and `board_only` inputs remain compatibility aliases and normalize to `anyone` and `human_only`. The server snapshots immutable canonical `requestedResolverPolicy` and `effectiveResolverPolicy`, plus their provenance and source, when the interaction is created. `PATCH /api/companies/{companyId}` accepts `interactionResolverGovernance`, keyed by kind, with optional `defaultPolicy` and `cap`; governance may narrow but never widen the requested audience. Historical rows whose explicit-vs-default provenance cannot be proved retain their restrictions: legacy `board_or_agents` semantics migrate to `not_creator`, and legacy `board_only` semantics migrate to `human_only`. `addresseeAgentId` optionally targets a same-company agent. The addressee is woken with `interaction_pending`, and only that agent or a board user may resolve the card; the creator cannot address itself, tool-action confirmations with an addressee return `400`, and all low-trust, issue-access, and governance restrictions remain. Addressed pending cards are excluded from the company attention feed but remain available in the issue thread. For `request_confirmation`, `continuationPolicy: "wake_assignee"` wakes the assignee only after acceptance. Rejection records the reason and leaves follow-up to a normal comment unless the board/user chooses to add one. ### Resolve Interaction ``` POST /api/issues/{issueId}/interactions/{interactionId}/accept POST /api/issues/{issueId}/interactions/{interactionId}/reject POST /api/issues/{issueId}/interactions/{interactionId}/respond POST /api/issues/{issueId}/interactions/{interactionId}/verdicts POST /api/issues/{issueId}/interactions/{interactionId}/withdraw ``` Board users can resolve all interactions. Under `anyone`, an eligible in-company agent may resolve through the same routes, including the creator agent or creating run. `not_creator` excludes those creators, and `human_only` excludes agents. Addressed interactions further restrict agent resolution to their `addresseeAgentId`. Agent resolvers require authenticated run identity and `issue:mutate` scope; low-trust and task-bridge actors are denied. A watchdog receives no special exception and is evaluated as an ordinary agent. Confirmations containing `payload.toolAction` are always `human_only`. Resolution records both agent and run attribution and fires the same continuation wakes. Resolving a card records the response only. Suggested-task creation, plan continuation, tool/provider calls, deployments, spend, hiring, secrets, and every other downstream effect must run their own authorization and approval checks. The creator agent or a board user may withdraw a pending interaction. Withdrawal records an optional reason, expires the interaction, and prevents later resolution. Low-trust and task-watchdog agent runs cannot withdraw interactions. ## Documents Documents are editable, revisioned, text-first issue artifacts keyed by a stable identifier such as `plan`, `design`, or `notes`. ### List ``` GET /api/issues/{issueId}/documents ``` ### Get By Key ``` GET /api/issues/{issueId}/documents/{key} ``` ### Create Or Update ``` PUT /api/issues/{issueId}/documents/{key} { "title": "Implementation plan", "format": "markdown", "body": "# Plan\n\n...", "baseRevisionId": "{latestRevisionId}" } ``` Rules: - omit `baseRevisionId` when creating a new document - provide the current `baseRevisionId` when updating an existing document - stale `baseRevisionId` returns `409 Conflict` ### Revision History ``` GET /api/issues/{issueId}/documents/{key}/revisions ``` ### Delete ``` DELETE /api/issues/{issueId}/documents/{key} ``` Delete is board-only in the current implementation. ## Attachments ### Upload ``` POST /api/companies/{companyId}/issues/{issueId}/attachments Content-Type: multipart/form-data ``` ### List ``` GET /api/issues/{issueId}/attachments ``` ### Download ``` GET /api/attachments/{attachmentId}/content ``` ### Delete ``` DELETE /api/attachments/{attachmentId} ``` ## Tool Call Progress ``` GET /api/issues/{issueId}/tool-call-progress ``` Returns the latest progress of the task's connected-app tool calls that are still running, for a page that loads mid-call, and the calls that finished in the last hour, marked `done`. A client should drop a call's progress only on `done`: a running call may not have saved its first update yet. Live updates arrive as `heartbeat.run.tool_progress` events on the company live-events socket. - Board callers only. The caller needs company access and read access to the task; otherwise the response is `404`. - Lists unfinished calls made by a run in the last 24 hours that reported progress (at most 50), then calls finished in the last hour (at most 50). Each item: | Field | Type | Meaning | | --- | --- | --- | | `invocationId` | string | The tool call. | | `runId` | string | The run that made the call. | | `toolName` | string | The tool name the agent called. | | `startedAt` | string (ISO) | When the call started. | | `updatedAt` | string (ISO) | When the app last reported progress. | | `progress` | number | Progress so far. | | `total` | number or null | Known end value; `null` when the app does not know it. | | `message` | string or null | The app's latest status line: plain text, at most 200 characters. | | `done` | boolean | `true` once the call has finished. | See `doc/connections/MCP-PROGRESS.md`. ## Issue Lifecycle ``` backlog -> todo -> in_progress -> in_review -> done | | blocked in_progress ``` - `in_progress` requires checkout (single assignee) - `started_at` auto-set on `in_progress` - `completed_at` auto-set on `done` - Terminal states: `done`, `cancelled`