Skip to content

Unarchive a cycle ​

POST/api/v2/workspaces/{slug}/projects/{project_id}/cycles/{pk}/unarchive/

Clear an archived cycle's archived_at and put the cycle back in the default cycle list.

This is a bodyless POST. A successful call returns 204 with an empty body. Unarchive has no date rule. Any archived cycle can be restored, whatever its end_date.

Path Parameters ​

slug:requiredstring

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

project_id:requiredstring (uuid)

The project the cycle belongs to.

pk:requiredstring (uuid)

The cycle's UUID. A cycle from another project returns 404.

Body Parameters ​

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

Safe to repeat

Unarchiving a cycle that is not archived returns 204 and changes nothing, so a retry never fails on state.

Scopes ​

projects.cycles:write

Errors ​

StatusCodeCause
400invalid_requestA malformed path parameter, for example a pk that isn't a 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 unarchive cycles in this project.
404not_foundNo such cycle, wrong project, or the record is outside your 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 cycle
bash
curl -X POST \
  "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/cycles/7c1f9a4e-3b6d-4a52-8f0c-2d9e6b18c3a7/unarchive/" \
  -H "X-Api-Key: $PLANE_API_KEY"
Response204

No response body.

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

What unarchiving changes ​

  • archived_at goes back to null. Nothing else on the cycle changes.
  • The cycle shows up in List cycles again without any archive parameter.
  • Favorites that archiving removed stay removed.