Archive a task list

POST /v1/lists/{listId}/archive

Archives a task list.

Archived lists no longer appear in GET /v1/lists or in the web sidebar, but their tasks remain accessible via the task endpoints. The API key’s owner must be a member of the list.

Idempotent — archiving an already-archived list returns success.

Connected web clients in the team receive a realtime tasklists refetch event so the list disappears from their sidebar.

Request

Path parameters

Name	Type	Required	Description
`listId`	string	yes	Numeric ID of the list.

No request body.

Response

200 OK — the archived list:

Field	Type	Description
`id`	number	Numeric ID of the list.
`name`	string	Display name of the list.
`color`	string	Color tag of the list.
`isArchived`	boolean	Always `true`.

Example response

{
  "id": 27,
  "name": "Q3 launch",
  "color": "Blue",
  "isArchived": true
}

Errors

Status	Body	When
`400`	`{ "error": "listId must be a number." }`	`listId` path parameter is not numeric.
`403`	`{ "error": "You do not have access to this list." }`	The API key’s owner is not a member of the list.
`404`	`{ "error": "List <id> not found." }`	No list with that ID exists in the bound team.