Sort cards in list

Sorts all cards within a list. Requires board editor permissions.

post/lists/{id}/sort

Request

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

Path parameters

idstring required

Example:1357158568008091264

ID of the list to sort

Request body

fieldName'name' | 'dueDate' | 'createdAt' required

Field to sort cards by

order'asc' | 'desc'

Sorting order

Example request

{
  "fieldName": "name",
  "order": "asc"
}

Response

List sorted 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"
  },
  "included": {
    "cards": [
      {
        "id": "1357158568008091264",
        "boardId": "1357158568008091265",
        "listId": "1357158568008091266",
        "creatorUserId": "1357158568008091267",
        "prevListId": "1357158568008091268",
        "coverAttachmentId": "1357158568008091269",
        "type": "project",
        "position": 65536,
        "name": "Implement user authentication",
        "description": "Add JWT-based authentication system...",
        "dueDate": "2024-01-01T00:00:00.000Z",
        "stopwatch": {
          "startedAt": "2024-01-01T00:00:00.000Z",
          "total": 3600
        },
        "commentsTotal": 100,
        "listChangedAt": "2024-01-01T00:00:00.000Z",
        "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.