# List a board's lists and cards

`GET https://evohub.io/api/v1/board/boards/{boardID}/lists`

Part of the [Board API](https://docs.evohub.io/board.md) reference · operationId `getBoardContent`.

The board's lists in display order, each with the first page of its
cards. Each list says how many cards it holds (`card_count`) and
whether more exist (`has_more`); read further with
*List a list's cards*. The filters below narrow
which cards count as being in a list, the counts included.

Requires the `board:list:read` scope.

## Authorization

Any one of:

- `bearerKey`
- `headerKey`

Where:

- `bearerKey`: HTTP Bearer — An EvoHub API key (`evohub_…`) as a bearer token.
- `headerKey`: API key in the header `X-API-Key` — An EvoHub API key (`evohub_…`).

## Path parameters

- `boardID` (string, required, example `brd_5b0c8e1a2f3d4c6b9a7e0d1f2c3b4a59`): The board's ID.

## Query parameters

- `cards` (integer, default `50`, min 1, max 500): Cards per list. Default 50, at most 500.
- `q` (string): Match card titles, case-insensitively. A reference such as `PLT-42`, or a bare number, also matches the card with that number.
- `assignee` (string, value `me`): `me` keeps only cards the caller is assigned to. Any other value is ignored.
- `label` (string): Keep only cards carrying this label ID.
- `due` (string, value `none`): `none` keeps only cards with no due date.
- `due_from` (string (date-time)): Keep only cards due at or after this RFC 3339 instant.
- `due_to` (string (date-time)): Keep only cards due at or before this RFC 3339 instant.
- `created_from` (string (date-time)): Keep only cards created at or after this RFC 3339 instant.
- `created_to` (string (date-time)): Keep only cards created at or before this RFC 3339 instant.

## Responses

### 200 — The lists and their first cards.

Content type: `application/json`

Type: `object`

- `data` (object)
  - `lists` (array of List)
    - `id` (string)
    - `board_id` (string)
    - `name` (string, max length 80)
    - `is_review_list` (boolean)
    - `is_done_list` (boolean)
    - `celebration` (Celebration, one of ``, `confetti`, `hearts`, `sparkles`, `fireworks`, `balloons`, `bubbles`, `petals`, `emoji`, `glow`)
    - `created_by` (string)
    - `created_at` (string (date-time))
    - `updated_at` (string (date-time))
    - `cards` (array of Card): The first page of the list's cards.
      - `id` (string, example `crd_9f2e4d6c8b0a1e3f5d7c9b1a3e5f7d90`)
      - `board_id` (string)
      - `list_id` (string)
      - `number` (integer): The card's number on its board, from 1. With the board's `card_prefix` it is the card's reference.
      - `title` (string, max length 200)
      - `description` (string, max length 20000)
      - `color` (string): A hex colour, or `""` for none.
      - `due_at` (string (date-time)): Absent when the card has no due date.
      - `review` (Review)
      - `completed_at` (string (date-time)): When the card entered a done list. Absent while it is not in one.
      - `created_by` (string)
      - `created_at` (string (date-time))
      - `updated_at` (string (date-time))
      - `version` (integer): Goes up by one on every edit of the title or description.
      - `assignee_ids` (array of string | null): Who the card is on. Filled in when a board or list is read; `null` when one card is read on its own.
      - `label_ids` (array of string | null): The labels the card carries. Filled in when a board or list is read; `null` when one card is read on its own.
    - `card_count` (integer): How many cards the list holds, under the filters.
    - `has_more` (boolean)

### 400 — A date filter is not an RFC 3339 timestamp (`VALIDATION_ERROR`).

Content type: `application/json`

Type: `Error`

- `error` (object, required)
  - `code` (string, required, example `NOT_FOUND`)
  - `message` (string, required, example `not found`)
  - `request_id` (string)

### 401 — No API key was sent, or it is unknown, revoked or expired (`UNAUTHORIZED`).

Content type: `application/json`

Type: `Error`

- `error` (object, required)
  - `code` (string, required, example `NOT_FOUND`)
  - `message` (string, required, example `not found`)
  - `request_id` (string)

### 403 — The key lacks the scope this endpoint needs (`FORBIDDEN`).

Content type: `application/json`

Type: `Error`

- `error` (object, required)
  - `code` (string, required, example `NOT_FOUND`)
  - `message` (string, required, example `not found`)
  - `request_id` (string)

### 404 — It does not exist, or it is on a board the caller cannot see (`NOT_FOUND`).

Content type: `application/json`

Type: `Error`

- `error` (object, required)
  - `code` (string, required, example `NOT_FOUND`)
  - `message` (string, required, example `not found`)
  - `request_id` (string)

### 429 — Too many requests (`RATE_LIMITED`). Wait for `Retry-After` seconds.

Headers:

- `Retry-After` (integer): Seconds to wait before retrying.

Content type: `application/json`

Type: `Error`

- `error` (object, required)
  - `code` (string, required, example `NOT_FOUND`)
  - `message` (string, required, example `not found`)
  - `request_id` (string)

### 500 — Something went wrong on EvoHub's side (`INTERNAL_ERROR`). Retry later.

Content type: `application/json`

Type: `Error`

- `error` (object, required)
  - `code` (string, required, example `NOT_FOUND`)
  - `message` (string, required, example `not found`)
  - `request_id` (string)

## Example request

```bash
curl -X GET 'https://evohub.io/api/v1/board/boards/brd_5b0c8e1a2f3d4c6b9a7e0d1f2c3b4a59/lists' \
  -H 'Authorization: Bearer <TOKEN>'
```