---
title: "Read a card"
method: GET
path: "/cards/{card}"
tags: ["Board"]
---

# Read a card

`GET /cards/{card}`

## Request

- Base URL: `https://api.yokka.ai/api/v1`
- URL: `https://api.yokka.ai/api/v1/cards/{card}`
- Auth: HTTP bearer

Read a card in full: its brief (what, why, done-when), swimlane, lane, labels, epic, priority, holder, checklist (items the human wrote are acceptance criteria), the cards it is blocked by and the cards it blocks, what those blockers delivered (their completion summary, pull requests and branch), the handoff note the last agent left when it let go, the project notes most relevant to it, attached files (with download links: the human may attach screenshots or mockups), linked GitHub pull requests (with their checks), branches and commits, and recent activity. Read the brief before you start working on a card. Its cursor lets get_card_activity show only what's new. An archived card reads the same, but is read-only.

Any token. Same as the MCP tool `get_card`.

## Path parameters

- `card` string, required: The card's ref, like "GS-12".

## Response `200`

The tool's result.

- object
  - `ref` string, required
  - `title` string, required
  - `archived` boolean, required
  - `swimlane` string, nullable, required
  - `lane` string, nullable, required
  - `backlog` boolean, required
  - `brief` string, required
  - `labels` string[], required
  - `epic` string, nullable, required
  - `priority` string, nullable, required
  - `attention` string, nullable, required
  - `heldByYou` boolean, required
  - `blocked` boolean, required
  - `blockedBy` object[], required
    - `ref` string, required
    - `title` string, required
    - `lane` string, nullable, required
    - `done` boolean, required
  - `blocks` object[], required
    - `ref` string, required
    - `title` string, required
    - `lane` string, nullable, required
    - `done` boolean, required
  - `upstream` object[], required
    - `ref` string, required
    - `title` string, required
    - `lane` string, nullable, required
    - `done` boolean, required
    - `summary` string, nullable, required
    - `links` string[], required
    - `pullRequests` object[], required
      - `repo` string, required
      - `number` integer, required
      - `title` string, required
      - `state` 'open' | 'draft' | 'merged' | 'closed', required
      - `url` string, required
    - `branches` object[], required
      - `repo` string, required
      - `name` string, required
      - `deleted` boolean, required
      - `url` string, required
  - `handoff` object, nullable, required
    - `note` string, required
    - `by` string, required
    - `from` 'human' | 'agent', required
    - `at` string, required
  - `checklist` object[], required
    - `number` integer, required
    - `text` string, required
    - `done` boolean, required
    - `from` 'human' | 'agent', required
  - `attachments` object[], required
    - `filename` string, required
    - `contentType` string, required
    - `size` integer, required
    - `caption` string, nullable, required
    - `from` string, required
    - `url` string, nullable, required
  - `code` object, required
    - `pullRequests` object[], required
      - `repo` string, required
      - `number` integer, required
      - `title` string, required
      - `state` 'open' | 'draft' | 'merged' | 'closed', required
      - `ci` string, nullable, required
      - `url` string, required
    - `branches` object[], required
      - `repo` string, required
      - `name` string, required
      - `deleted` boolean, required
      - `url` string, required
    - `commits` object[], required
      - `repo` string, required
      - `sha` string, required
      - `title` string, required
      - `url` string, required
  - `notes` object[], required
    - `number` integer, required
    - `title` string, required
    - `body` string, required
    - `truncated` boolean, required
    - `pinned` boolean, required
    - `card` string, nullable, required
    - `from` 'human' | 'agent', required
    - `by` string, required
    - `updatedAt` string, required
  - `cursor` string, nullable, required

## Other responses

- `400`: The arguments aren't valid, or the change isn't possible as asked.
- `401`: The token is missing, invalid, revoked or expired.
- `404`: Something it names wasn't found, or isn't visible to this token.
- `429`: Too many calls: retry after `Retry-After` seconds.

---

[API](https://skmtc.dev/yokka/apis/yokka-rest-api.md) · [All operations](https://skmtc.dev/yokka/apis/yokka-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/yokka/apis/yokka-rest-api/revisions/19083353485e?raw)