TOtodoist
Projects

Archive Project

Changed on

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

Request

  • Base URL
    https://api.todoist.com
  • URL
    https://api.todoist.com/api/v1/projects/{project_id}/archive
  • Auth
    none declared

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",
  "icon": "lightbulb",
  "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,
  "default_order_key": "a1V",
  "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"
}

Changes

  • 606e71857476Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • 4d3e9a31270eRevision changes
    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status