---
title: "Get board schema"
method: GET
path: "/api/schema/{boardId}"
tags: ["Schema"]
---

# Get board schema

`GET /api/schema/{boardId}`

## Request

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

Returns the list of fields defined on the board. Always fetch the schema first so
you know which field keys to use when reading or writing card data.

## Path parameters

- `boardId` string, required

## Response `200`

Array of field definitions.

- SchemaField[]
  - `key` string: Field UUID — use this as the key when reading/writing card data.
  - `label` string: Human-readable field name.
  - `type` string: Field type (e.g. text, date, money, multiselect, etc.)

## Other responses

- `401`: Invalid or missing API key.
- `403`: API access is disabled for this board.
- `404`: Board 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)