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.

The Aptly API lets you integrate external tools, scripts, and AI agents directly with your Aptly boards.

​
What you can do

  • List and retrieve cards — paginate through all cards or fetch a single card by ID
  • Create and update cards — push data into any board field using field keys from the schema
  • Add comments and files — attach notes or documents to cards
  • Add tab views — embed external URLs as tabs on a board
  • Read the board schema — discover field keys and types before reading or writing data

​
Base URL

https://core-api.getaptly.com

​
Quick start

1

Enable the API for your board

In Aptly, open the board → Card Sources → API and toggle the API on.
2

Create an API key

Under the API section, click Create New Key, give it a name, and copy the key value.
3

Fetch the schema

curl https://core-api.getaptly.com/api/schema/{boardId} \
  -H "x-token: YOUR_API_KEY"
This returns the list of field keys you’ll need for reading and writing cards.
4

Create a card

curl -X POST https://core-api.getaptly.com/api/board/{boardId} \
  -H "x-token: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "name": "John Smith", "<fieldKey>": "<value>" }'