Skip to main content
GET
List cards (deprecated)

Authorizations

x-token
string
header
required

Path Parameters

boardId
string
required

The board's UUID.

Query Parameters

page
integer
required

Zero-based page number. Legacy GET parses the base-10 integer prefix (1.5 or 1e2 becomes 1).

Required range: 0 <= x <= 9999
pageSize
integer
default:20

Number of cards per page. Legacy GET parses the base-10 integer prefix; omitted or empty defaults to 20.

Required range: 1 <= x <= 1000
updatedAtMin
string<date-time>

Only return cards updated after this ISO timestamp.

includeArchived
boolean
default:false

Include archived cards. Legacy GET treats empty or the exact string false as false; any other nonempty string (including 1 or 0) as true. Omitted lets archive rules control selection.

Only return cards where references.value contains this ID.

contactEmail
string

Resolves the email to contact IDs, then filters cards referencing those contacts.

keyTerm
string

Full-text autocomplete search on card title using the Atlas Search index.

assignee
string

Filter cards by assignee user ID.

segmentId
string

Existing accessible, active segment on this board; mutually exclusive with rules.

Maximum string length: 256
rules
string

JSON-encoded BoardFilterRule array, at most 100 rules. Prefer POST /list with a native JSON array.

Maximum string length: 64000
userId
string

Active company member whose private segments/currentUser values to use. API keys/partners may select a member; delegates cannot select another user.

Maximum string length: 256

Response

Paginated list of cards.

data
object[]
count
integer

Total number of matching cards.

page
integer
pageSize
integer