Archive a work item

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

Archive a work item. This sets archived_at to the current time and removes the work item from the active work item set.

This POST takes no body, so send no JSON. The response is the full work item in its usual read shape, with archived_at now populated, so you can confirm the change without a follow-up read.

You can reverse it with Unarchive a work item. Archiving is separate from deleting: an archived work item still exists.

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

The work item's UUID or its identifier, such as PROJ-142.

Body parameters

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

Archiving twice returns 404

Once archived, a work item is outside the default query set, so a second archive call on the same work item can't find it and returns 404 not_found. It doesn't return 409 or report success. If you're re-running a job, treat a 404 here as "already archived" instead of an error to retry.

Response shaping

fields:optionalstring

Comma-separated list of fields to return. Fields you don't request are left out of the response instead of coming back as null, so a missing key means you didn't ask for it and null means the value is null. id is always included, whether or not you name it.

Pass all to get every requestable field. An unknown field name returns 400 with the list of valid names and the closest match, so a typo is caught instead of being silently ignored.

Requestable here: archived_at, assignee_ids, completed_at, created_at, created_by_id, custom_fields, cycle_id, description_html, estimate_point_id, external_id, external_source, id, identifier, is_draft, label_ids, module_ids, name, parent_id, priority, project_id, sequence_id, sort_order, start_date, state_id, target_date, type_id, updated_at, updated_by_id.

See Sparse fields.

expand:optionalstring

Comma-separated relations to embed alongside the ids: assignees (the assigned users), cycle (the cycle it belongs to), estimate_point (its estimate point), 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).

Expanded objects get their own 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 returns 400.

?fields= and ?expand= take separate sets of names. Relation names aren't valid in ?fields=, field names aren't valid in ?expand=, and field filtering never removes an expanded object: ?fields=id,name&expand=state returns id, name and state. See Expanding relations.

Scopes

projects.work_items:write

Errors

Status	Code	Cause
400	invalid_request	The request could not be processed, for example because pk isn't a valid UUID.
401	unauthorized	Missing or invalid credentials.
402	payment_required	The feature this endpoint belongs to isn't enabled on your plan, or is switched off.
403	forbidden	Your role or token scope can't archive this work item.
404	not_found	No such work item, it's outside your project or tenant, or it is already archived.
406	not_acceptable	The Accept header asks for a representation the API can't produce.
409	conflict	The write collides with a protected-resource constraint.
413	payload_too_large	The request body is over the size limit.
415	unsupported_media_type	The Content-Type isn't one this endpoint accepts.
429	rate_limited	Throttled. Honor the Retry-After header before retrying.

Archive a work item

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/archive/" \
  -H "X-Api-Key: $PLANE_API_KEY"

import requests

response = requests.post(
    "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b"
    "/work-items/8f4c2b1e-0d3a-4f7b-9c21-6e5a8b7d4f13/archive/",
    headers={"X-Api-Key": "your-api-key"},
)
print(response.json()["archived_at"])

const response = await fetch(
  "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b" +
    "/work-items/8f4c2b1e-0d3a-4f7b-9c21-6e5a8b7d4f13/archive/",
  {
    method: "POST",
    headers: { "X-Api-Key": "your-api-key" },
  },
);
const data = await response.json();

Response200

{
  "id": "8f4c2b1e-0d3a-4f7b-9c21-6e5a8b7d4f13",
  "name": "Fix login redirect loop",
  "description_html": "<p>Signing in after a session expires sends the user back to the login page in a loop.</p>",
  "identifier": "PROJ-142",
  "sequence_id": 142,
  "priority": "high",
  "project_id": "4af68566-94a4-4eb3-94aa-50dc9427067b",
  "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"],
  "cycle_id": null,
  "module_ids": [],
  "parent_id": null,
  "estimate_point_id": null,
  "start_date": "2026-01-12",
  "target_date": "2026-01-20",
  "is_draft": false,
  "sort_order": 85535.0,
  "completed_at": null,
  "archived_at": "2026-02-03T11:47:19.204518Z",
  "external_id": null,
  "external_source": null,
  "created_at": "2026-01-14T09:22:41.478363Z",
  "updated_at": "2026-01-15T11:35:48.478363Z",
  "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "updated_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

{
  "type": "not_found",
  "code": "not_found",
  "detail": "The requested resource was not found."
}

What archiving changes

• archived_at goes from null to a timestamp. It is the only field the call changes. State, assignees, dates, and labels stay as they were.
• The work item drops out of List work items and out of plain detail reads, including the identifier route. The list returns it again when you pass ?archived=true or ?archived=only.
• Nothing is deleted. Comments, links, and relations survive, and unarchiving restores the work item exactly as it was.

archived_at is read-only on the work item itself, so you can't archive by PATCHing a timestamp. This endpoint is the only way to archive a work item, and unarchive is the only way to restore it.