curl --request POST \
--url https://core-api.getaptly.com/api/board/{boardId}/list \
--header 'Content-Type: application/json' \
--header 'x-token: <api-key>' \
--data '
{
"page": 0,
"pageSize": 20,
"segmentId": "SEGMENT_ID",
"userId": "USER_ID"
}
'{
"data": [
{
"cardId": "<string>",
"boardUuid": "<string>",
"archived": true,
"assignee": "<string>",
"lastActivity": {
"content": "<string>",
"type": "<string>",
"direction": "in",
"publishedAt": "2023-11-07T05:31:56Z",
"conversationUrl": "<string>"
}
}
],
"count": 123,
"page": 123,
"pageSize": 123
}List cards
Returns a paginated list of cards on the board.
Field values are keyed by field UUID — use the schema endpoint to map keys to labels.
Money fields are returned as { amount, currency } where amount is a decimal.
All filter params are optional and ANDed together.
Supply segmentId OR rules (a JSON array), never both. Rules use the existing saved-segment format. Invalid rules fail with 400; missing, private-to-another-user, archived, or wrong-board segments return 404.
Auth: API key, delegate token (boards:* or boards: read scope), or partner bearer token with board-admin. Mobile tokens are not accepted. Keys/delegates require API-enabled boards; partner access retains its existing API-enabled bypass. API keys/partners may supply userId for an active company member; delegates can only use their token user. Without userId only public segments are visible. Public means company-shared.
This /list POST performs no writes and does not change POST /api/board/, which creates/updates cards. Rules are ANDed. Relative dates are evaluated on each request. See the Board segments guide for values, field comparisons, business-hours rules, and examples.
curl --request POST \
--url https://core-api.getaptly.com/api/board/{boardId}/list \
--header 'Content-Type: application/json' \
--header 'x-token: <api-key>' \
--data '
{
"page": 0,
"pageSize": 20,
"segmentId": "SEGMENT_ID",
"userId": "USER_ID"
}
'{
"data": [
{
"cardId": "<string>",
"boardUuid": "<string>",
"archived": true,
"assignee": "<string>",
"lastActivity": {
"content": "<string>",
"type": "<string>",
"direction": "in",
"publishedAt": "2023-11-07T05:31:56Z",
"conversationUrl": "<string>"
}
}
],
"count": 123,
"page": 123,
"pageSize": 123
}Authorizations
Path Parameters
The board's UUID.
Body
Read-only card listing. Supply segmentId OR rules; existing simple filters intersect with either. Segment/rule queries exclude deleted cards unless explicitly selected by a rule. No filter or card is saved. Saved segments must contain a rules array; missing or malformed rules require re-saving. An explicitly empty rules array matches all cards within the remaining filters.
Zero-based page number.
0 <= x <= 9999Number of cards per page.
1 <= x <= 1000Only return cards updated after this ISO timestamp.
Include archived cards. If omitted, an explicit archived rule controls archive selection; otherwise active cards only. An explicit false intersects with the rules.
Only return cards where references.value contains this ID.
Resolves the email to contact IDs, then filters cards referencing those contacts.
Full-text autocomplete search on card title using the Atlas Search index.
Filter cards by assignee user ID.
Existing accessible, active segment on this board; mutually exclusive with rules.
256Ad hoc saved-segment rules, ANDed together. Requires an explicit board. Supply rules OR segmentId. Invalid rules are rejected.
100Show child attributes
Show child attributes
Active company member whose private segments/currentUser values to use. API keys/partners may select a member; delegates cannot select another user.
256