List a board's lists and cards
The board's lists in display order, each with the first page of its
cards. Each list says how many cards it holds (card_count) and
whether more exist (has_more); read further with
List a list's cards. The filters below narrow
which cards count as being in a list, the counts included.
Requires the board:list:read scope.
Authorization
Parameters
Path parameters
boardIDstring requiredThe board's ID.
Query parameters
cardsintegerCards per list. Default 50, at most 500.qstringMatch card titles, case-insensitively. A reference such asPLT-42, or a bare number, also matches the card with that number.assigneestringmekeeps only cards the caller is assigned to. Any other value is ignored.labelstringKeep only cards carrying this label ID.duestringnonekeeps only cards with no due date.due_fromstring (date-time)Keep only cards due at or after this RFC 3339 instant.due_tostring (date-time)Keep only cards due at or before this RFC 3339 instant.created_fromstring (date-time)Keep only cards created at or after this RFC 3339 instant.created_tostring (date-time)Keep only cards created at or before this RFC 3339 instant.
Responses
200
The lists and their first cards.
dataobjectlistsarray of ListShow List properties
idstringboard_idstringnamestringis_review_listbooleanis_done_listbooleancelebrationCelebrationcreated_bystringcreated_atstring (date-time)updated_atstring (date-time)cardsarray of CardThe first page of the list's cards.Show Card properties
idstringboard_idstringlist_idstringnumberintegerThe card's number on its board, from 1. With the board'scard_prefixit is the card's reference.titlestringdescriptionstringcolorstringA hex colour, or""for none.due_atstring (date-time)Absent when the card has no due date.reviewReviewShow Review properties
statestringapproved_bystringapproved_atstring (date-time)
completed_atstring (date-time)When the card entered a done list. Absent while it is not in one.created_bystringcreated_atstring (date-time)updated_atstring (date-time)versionintegerGoes up by one on every edit of the title or description.assignee_idsarray of string | nullWho the card is on. Filled in when a board or list is read;nullwhen one card is read on its own.label_idsarray of string | nullThe labels the card carries. Filled in when a board or list is read;nullwhen one card is read on its own.
card_countintegerHow many cards the list holds, under the filters.has_moreboolean
400
A date filter is not an RFC 3339 timestamp (VALIDATION_ERROR).
errorobject requiredcodestring requiredmessagestring requiredrequest_idstring
401
No API key was sent, or it is unknown, revoked or expired (UNAUTHORIZED).
errorobject requiredcodestring requiredmessagestring requiredrequest_idstring
403
The key lacks the scope this endpoint needs (FORBIDDEN).
errorobject requiredcodestring requiredmessagestring requiredrequest_idstring
404
It does not exist, or it is on a board the caller cannot see (NOT_FOUND).
errorobject requiredcodestring requiredmessagestring requiredrequest_idstring
429
Too many requests (RATE_LIMITED). Wait for Retry-After seconds.
Retry-AfterintegerSeconds to wait before retrying.
errorobject requiredcodestring requiredmessagestring requiredrequest_idstring
500
Something went wrong on EvoHub's side (INTERNAL_ERROR). Retry later.
errorobject requiredcodestring requiredmessagestring requiredrequest_idstring
Example request
curl -X GET 'https://evohub.io/api/v1/board/boards/brd_5b0c8e1a2f3d4c6b9a7e0d1f2c3b4a59/lists' \
-H 'Authorization: Bearer <TOKEN>'
