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}

Get board schema

cURL

curl --request GET \
  --url https://core-api.getaptly.com/api/schema/{boardId} \
  --header 'x-token: <api-key>'

200

[
  {
    "key": "abc123",
    "label": "Tenant Name",
    "type": "text"
  },
  {
    "key": "def456",
    "label": "Move-in Date",
    "type": "date"
  },
  {
    "key": "ghi789",
    "label": "Monthly Rent",
    "type": "money"
  }
]

Authorizations

x-token · string · header · required

Path Parameters

boardId · string · required

The board's UUID (aptlet.uuid).

Response

200

application/json

Array of field definitions.

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