Schema

Get board 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.

get/api/schema/{boardId}

Request

Base URL
https://core-api.getaptly.com
Auth
- API key in header x-token
- or 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.

boardIdstring required

The board's UUID (aptlet.uuid).

Array of field definitions.

keystring

Field UUID — use this as the key when reading/writing card data.

labelstring

Human-readable field name.

typestring

Field type (e.g. text, date, money, multiselect, etc.)

No recorded changes to this operation across all 1 revision of this API.