Skip to main content

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.

When you fetch the board schema, each field includes a type property. This type determines what value format the API expects when you create or update a card. Always fetch the schema before writing to a board so you know the key and type for each field.

​
Field types

​
text

A plain text string. 
{ "<fieldKey>": "123 Main Street" }

​
number

A numeric value. Do not wrap in quotes. 
{ "<fieldKey>": 3 }

​
money

A numeric value representing a dollar amount. Do not include currency symbols or commas. 
{ "<fieldKey>": 1850.00 }

​
date

An ISO 8601 date string. 
{ "<fieldKey>": "2025-09-01" }

​
datetime

An ISO 8601 datetime string with timezone. 
{ "<fieldKey>": "2025-09-01T10:00:00.000Z" }

​
boolean

true or false. 
{ "<fieldKey>": true }

​
select

A single string value matching one of the field’s configured options exactly. Option values are case-sensitive. 
{ "<fieldKey>": "Active" }

​
multiselect

An array of strings, each matching a configured option exactly. 
{ "<fieldKey>": ["Dog", "Cat"] }

​
person

A single contact ID string referencing a contact in your company. 
{ "<fieldKey>": "<contactId>" }

​
persons

An array of contact ID strings. 
{ "<fieldKey>": ["<contactId1>", "<contactId2>"] }

​
email

A valid email address string. 
{ "<fieldKey>": "[email protected]" }

​
phone

A phone number string. Include country code for best compatibility. 
{ "<fieldKey>": "+14155551234" }

​
url

A fully qualified URL string. 
{ "<fieldKey>": "https://example.com" }

​
file

Files are attached via the Upload a file to a card endpoint, not via field keys in the card body.

​
Reading field values

When you fetch a card, field values are returned using the same key/value structure. Null or unset fields are returned as null.

​
Unknown types

If the schema returns a type not listed here, treat the value as a plain string and contact Aptly support to confirm the expected format.