Skip to main content
GET
/
api
/
schema
/
{boardId}
Get board schema
curl --request GET \
  --url https://core-api.getaptly.com/api/schema/{boardId} \
  --header 'x-token: <api-key>'
[
  {
    "key": "abc123",
    "label": "Tenant Name",
    "type": "text"
  },
  {
    "key": "def456",
    "label": "Move-in Date",
    "type": "date"
  },
  {
    "key": "ghi789",
    "label": "Monthly Rent",
    "type": "money"
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.getaptly.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-token
string
header
required

Path Parameters

​
boardId
string
required

The board's UUID (aptlet.uuid).

Response

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