Cards

List cards (deprecated)

Deprecated: use POST /api/board/{boardId}/list. Both endpoints use the same read-only listing implementation and response. GET remains supported.

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-encoded 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:{boardId} 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.

get/api/board/{boardId}

Request

Base URL
https://core-api.getaptly.com
Auth
- API key in header x-token
- or API key in header Authorization
- or HTTP bearer
TypeScript
https://skmtc.dev/getaptly/apis/aptly-api/docs/api/board/:boardId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

boardIdstring required

The board's UUID.

Query parameters

pageinteger required

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

pageSizeinteger

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

updatedAtMinstring date-time

Only return cards updated after this ISO timestamp.

includeArchivedboolean

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.

relatedIdstring

Only return cards where references.value contains this ID.

contactEmailstring

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

keyTermstring

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

assigneestring

Filter cards by assignee user ID.

segmentIdstring

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

rulesstring

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

userIdstring

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

Response

Paginated list of cards.

countinteger

Total number of matching cards.

pageinteger