latestOpenAPI 3.1.02026-08-211061591.1 MB

69a962f1578f

Projects

Archive Project

Marks a project as archived. For personal projects, this will archive it just for the initiating user (leaving it visible to any other collaborators). For workspace projects, this will archive it for all workspace users, removing it from view.

post/api/v1/projects/{project_id}/archive

Path parameters

project_idstring required

String ID of the project

Example:6XGgm6PHrGgMpCFX

Response

Successful Response

OR

Example response

{
  "id": "6XGgm6PHrGgMpCFX",
  "can_assign_tasks": true,
  "can_comment": true,
  "child_order": 1,
  "order_key": "a0",
  "color": "charcoal",
  "creator_uid": "1234567",
  "created_at": "2025-01-15T10:30:00Z",
  "name": "Inbox",
  "updated_at": "2025-01-16T10:30:00Z",
  "view_style": "list",
  "default_order": 1,
  "description": "Tasks for the launch plan",
  "public_key": "550e8400-e29b-41d4-a716-446655440000",
  "access": {
    "configuration": {
      "hide_collaborator_details": true,
      "disable_duplication": true
    }
  },
  "role": "admin",
  "parent_id": "6XGgm6PHrGgMpCFX"
}