Get board schema

Returns the field schema for the board, including all field names and their UUIDs.

GET /schema/{boardId}

Get board schema

cURL

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

200

{
  "fields": [
    {
      "uuid": "abc123-uuid",
      "name": "Priority",
      "type": "select"
    }
  ]
}

Headers

x-token · string · required

Your Aptly API Token. Available in the Aptly UI under Card Sources > API.

Path Parameters

boardId · string · required

The unique ID of the board.

Response

200

application/json

Board schema

fields · object[]

Show child attributes