GET/boards/columns/{id}/cards.json

List Cards in a Column

Important notice: This endpoint will be deprecated soon and replaced with a new Workflow endpoint, date to be confirmed.

List the existing Cards inside a Column.


Path Params

  • Name
    id
    Type
    string
    required
    Description

Query Params

  • Name
    page
    Type
    integer
    Description

    Optionally, you can set the page from which to start retrieving results. This is usually used in conjunction with the parameter pageSize.

    See How does paging work for more detailed documentation on pagination. For example: ?page=2&pageSize=10 will retrieve results 10-20.

  • Name
    pageSize
    Type
    integer
    Description

    The amount of cards returned can be limited using this parameter. Normally used in conjunction with the page parameter. Minimum: 1

  • Name
    showDeleted
    Type
    boolean
    Description

    Show deleted Columns in the API response or not

    Default
    false
  • Name
    deletedAfterDate
    Type
    string
    Description

    deletedAfterDate

  • Name
    updatedAfterDate
    Type
    string
    Description

    Show Columns updated after a given date

  • Name
    searchTerm
    Type
    string
    Description

    An optional term to filter down to Cards containing this text in the Cards name

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 Response

Examples

200 Response

application/json
{
  "people": {
    "12345": {
      "company": {
        "name": "My Company",
        "id": "1234"
      },
      "avatarUrl": "https://path/to/person.jpg",
      "firstName": "Joe",
      "id": "123",
      "lastName": "Bloggs"
    }
  },
  "STATUS": "OK",
  "column": {
    "name": "Inbox Column",
    "id": "1003",
    "color": "#3D82DE"
  },
  "cards": [
    {
      "dueDate": "",
      "canComplete": true,
      "numComments": "0",
      "taskListId": "123456789",
      "displayOrder": "1",
      "hasTickets": false,
      "archived": false,
      "deletedDate": "",
      "dateUpdated": "yyyy-mm-ddThh:mm:ssZ",
      "dateCompleted": "",
      "private": "0",
      "projectId": "1",
      "status": "ACTIVE",
      "numPredecessors": "0",
      "numDependencies": "0",
      "numAttachments": "0",
      "canEdit": true,
      "tags": [],
      "startDate": "",
      "id": "1002",
      "hasLoggedTime": false,
      "dateCreated": "yyyy-mm-ddThh:mm:ssZ",
      "completed": false,
      "estimatedMinutes": "0",
      "deleted": false,
      "taskListName": "A task list",
      "taskStatus": "new",
      "columnId": "101",
      "name": "My task name",
      "description": "",
      "priority": "NONE",
      "progress": "0",
      "parentTaskId": "",
      "numActiveSubTasks": "0",
      "assignedPeople": [
        "123"
      ],
      "taskId": "123456789",
      "isRecurring": false,
      "hasUnreadComments": false,
      "archivedDate": ""
    }
  ]
}