Sign in
Lists

Clear list

Deletes all cards from a list. Only works with trash-type lists. Requires project manager or board editor permissions.

post/lists/{id}/clear

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/lists/{id}/clear
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key

Path parameters

idstring required
Example:1357158568008091264

ID of the list to clear (must be a trash-type list)

Response

List cleared successfully

Example response

{
  "item": {
    "id": "1357158568008091264",
    "boardId": "1357158568008091265",
    "type": "active",
    "position": 65536,
    "name": "To Do",
    "color": "lagoon-blue",
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-01T00:00:00.000Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.