Sign in
Projects

Archive project

Hide a project from the default list without deleting it. Reversible with unarchive.

put/project/{id}/archive

Path parameters

idstring required

Response

The archived project

idstring required
workspaceIdstring required
slugstring required

Short prefix used in task identifiers, e.g. KAN-12.

iconstring nullable required
namestring required
descriptionstring nullable required
createdAtstring date-time required
isPublicboolean nullable required

When true the project's board is readable without signing in, via /api/public-project/{id}.

archivedAtstring date-time nullable required

Non-null once archived; archived projects are hidden by default.

positionnumber required

Sidebar order, ascending.

lastTaskNumbernumber required

Highest task number issued in this project; the next task gets this plus one.

Changes

Changed in 2 of the 23 revisions of this API.16

  • 08bbb5bedb5d15See the full diff
    • ▲

      the archivedAt response's property type/format changed from / to string null/date-time for status 200

      response-property-type-changed

    • ○

      added the non-success response with the status 400

      response-non-success-status-added

    • ○

      added the non-success response with the status 401

      response-non-success-status-added

    • ○

      added the non-success response with the status 403

      response-non-success-status-added

    • ○

      added the required property lastTaskNumber to the response with the 200 status

      response-required-property-added

    • ○

      added the required property position to the response with the 200 status

      response-required-property-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 32cece1ebe431See the full diff
    • ○

      endpoint added

      endpoint-added