---
title: "List boards"
method: GET
path: "/api/boards"
tags: ["Boards"]
---

# List boards

`GET /api/boards`

## Request

- Base URL: `https://core-api.getaptly.com`
- URL: `https://core-api.getaptly.com/api/boards`
- Auth: one of:
  - API key in header `x-token`
  - API key in header `Authorization`
- TypeScript: <https://skmtc.dev/getaptly/apis/aptly-api/docs/api/boards/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns all boards in your company that have API access enabled.
Each board includes its UUID, display name, and a list of pre-built endpoint URLs
you can use to interact with cards on that board.

Accepts an API key (`x-token`) or a delegate token (`Authorization: DelegateToken <token>`).

## Response `200`

List of API-enabled boards.

- object
  - `data` Board[]
    - `uuid` string: Board UUID — use this as `boardId` in board/card endpoints.
    - `name` string: Display name of the board.
    - `endpoints` object[]: Pre-built endpoint URLs for this board.
      - `method` string: HTTP method.
      - `url` string: Full endpoint URL.
      - `description` string: What the endpoint does.

## Other responses

- `401`: Invalid or missing API key.

---

[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)
