---
title: "List cards (deprecated)"
method: GET
path: "/api/board/{boardId}"
tags: ["Cards"]
deprecated: true
---

# List cards (deprecated)

`GET /api/board/{boardId}`

## Request

- Base URL: `https://core-api.getaptly.com`
- URL: `https://core-api.getaptly.com/api/board/{boardId}`
- Auth: one of:
  - API key in header `x-token`
  - API key in header `Authorization`
  - 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)

> **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.

## Path parameters

- `boardId` string, required

## Query parameters

- `page` integer, required
- `pageSize` integer
- `updatedAtMin` string, date-time
- `includeArchived` boolean
- `relatedId` string
- `contactEmail` string
- `keyTerm` string
- `assignee` string
- `segmentId` string
- `rules` string
- `userId` string

## Response `200`

Paginated list of cards.

- object
  - `data` Card[]
    - `cardId` string: Unique ID of the card.
    - `boardUuid` string: UUID of the board this card belongs to.
    - `archived` boolean
    - `assignee` string: Full name of the assigned user.
    - `lastActivity` object, nullable: Most recent conversation activity on the card (email, SMS or call), or null if the card has none.
      - `content` string, nullable: Body/text preview of the most recent message.
      - `type` string, nullable: Activity type, e.g. `email`, `sms`, `voice`.
      - `direction` 'in' | 'out', nullable: Direction of the message — `in` (inbound) or `out` (outbound).
      - `publishedAt` string, date-time, nullable
      - `conversationUrl` string, nullable: Deep link to the conversation thread in Aptly. Null when the activity is not attached to a thread.
  - `count` integer: Total number of matching cards.
  - `page` integer
  - `pageSize` integer

## Other responses

- `400`: Invalid rules, query parameters, or missing user context.
- `401`: Invalid or missing API key.
- `403`: Read access denied, API disabled, company mismatch, or invalid user selection.
- `404`: Board or accessible active segment not found.

---

[API](https://skmtc.dev/getaptly/apis/aptly-api.md) - [All operations](https://skmtc.dev/getaptly/apis/aptly-api/llms.txt) - [OpenAPI document](https://skmtc.dev/getaptly/apis/aptly-api/revisions/75c367e0b8e5?raw)