Skip to content

Unarchive a work item ​

POST/api/v2/workspaces/{slug}/projects/{project_id}/work-items/{pk}/unarchive/

Restore an archived work item: clear archived_at and put it back into the active set, where it shows up in lists and plain detail reads again.

This is a bodyless POST — send no JSON at all. The response is the full work item in its usual read shape with archived_at back to null.

Unlike most detail routes, this one deliberately looks past the archive filter to find the work item — that is the whole point. It also means the call is safe to repeat: unarchiving a work item that isn't archived succeeds and changes nothing.

Path Parameters ​

slug:requiredstring

The workspace slug. It appears in your Plane URLs — in https://app.plane.so/my-team/projects/, the slug is my-team.

project_id:requiredstring (uuid)

The project the work item belongs to.

pk:requiredstring (uuid)

The work item's UUID. This lookup is UUID-only — a PROJ-142 identifier here returns 404.

Body Parameters ​

None. The endpoint takes no request body; anything you send is ignored.

Safe to retry

Unarchive resolves archived and active work items alike, so a repeat call is a no-op that returns 200 with archived_at: null. Archive is the asymmetric one — see Archive a work item.

Response shaping ​

fields:optionalstring

Comma-separated list of fields to return. Unrequested keys are omitted from the response, not returned as null, so absent means "not requested" and null means "actually null". id always comes back whether or not you name it.

Pass all for every requestable field. An unknown name is a 400 that lists the valid set and suggests the closest match, so a typo can't silently cost you the saving.

Requestable here: archived_at, assignee_ids, created_at, created_by_id, custom_fields, cycle_id, id, identifier, is_draft, label_ids, module_ids, name, parent_id, priority, project_id, sequence_id, start_date, state_id, target_date, type_id.

See Sparse fields.

expand:optionalstring

Comma-separated relations to embed alongside the ids: assignees (the assigned users), cycle (the cycle it belongs to), labels (the applied labels), modules (the modules it belongs to), parent (its parent work item), state (the work item's state object), type (its work item type).

Expansion is separate-key: ?expand=state keeps state_id and adds a state object next to it, so an id is never replaced by an object. An unknown value is a 400.

?fields= and ?expand= are independent namespaces. Relation names are not valid ?fields= tokens (and vice versa), and an expanded object survives field filtering — ?fields=id,name&expand=state returns id, name and state. See Expanding relations.

Scopes ​

projects.work_items:write

Errors ​

StatusCodeCause
400invalid_requestThe request could not be processed — for example a pk that isn't a valid UUID.
401unauthorizedMissing or invalid credentials.
402payment_requiredThe feature this endpoint belongs to isn't enabled on your plan, or is switched off.
403forbiddenYour role or token scope can't archive or unarchive this work item.
404not_foundNo such work item, or it's outside your project or tenant.
406not_acceptableThe Accept header asks for a representation the API can't produce.
409conflictThe write collides with a protected-resource constraint.
413payload_too_largeThe request body is over the size limit.
415unsupported_media_typeThe Content-Type isn't one this endpoint accepts.
429rate_limitedThrottled. Honor the Retry-After header before retrying.
Unarchive a work item
bash
curl -X POST \
  "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/work-items/8f4c2b1e-0d3a-4f7b-9c21-6e5a8b7d4f13/unarchive/" \
  -H "X-Api-Key: $PLANE_API_KEY"
Response200
json
{
  "id": "8f4c2b1e-0d3a-4f7b-9c21-6e5a8b7d4f13",
  "name": "Fix login redirect loop",
  "identifier": "PROJ-142",
  "sequence_id": 142,
  "priority": "high",
  "state_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "type_id": "2d9d1a97-5c6f-4a1e-9d5b-8c2f7e30b6a4",
  "assignee_ids": ["16c61a3a-512a-48ac-b0be-b6b46fe6f430"],
  "label_ids": ["c1b8f3d6-9a44-4e12-8f7a-2b6d5c9e1a03"],
  "parent_id": null,
  "start_date": "2026-01-12",
  "target_date": "2026-01-20",
  "is_draft": false,
  "archived_at": null,
  "created_at": "2026-01-14T09:22:41.478363Z",
  "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "custom_fields": {
    "Severity": {
      "id": "5e2a7c81-4f39-4b60-a1d8-0c6b3e9f2d74",
      "value": ["Sev-2"],
      "value_detail": [{ "id": "c1b8f3d6-9a44-4e12-8f7a-2b6d5c9e1a03", "name": "Sev-2" }]
    }
  }
}
Response404
json
{
  "type": "not_found",
  "code": "not_found",
  "detail": "The requested resource was not found."
}

What comes back, and what doesn't ​

The response is the work item's standard read shape with archived_at cleared. Because this is a single-object response, custom_fields is populated here — the archive verbs return the same shape as Get a work item, custom property values included. It is only collection responses that omit custom_fields.

Nothing else is restored or changed, because nothing else was touched when the work item was archived: state, assignees, labels, dates, comments, and relations all survived the archive untouched.

Finding archived work items to restore ​

Archived work items are excluded from List work items and from plain detail reads, so the API gives you nothing to browse them with. Record the id when you archive — the archive response returns it — or pick the work item out of the Plane app's archive view, then unarchive it by UUID. This route is the one place an archived work item still resolves.