Skip to main content

​
Overview

This guide walks you through enabling the API on a board, retrieving your credentials, and posting your first card.

​
Step 1: Enable the API on a board

  1. Open the board you want to connect to
  2. Click Card Sources in the board toolbar
  3. Select API
  4. Toggle the switch to enable the REST API
  5. Copy your API Key and POST URL
Keep both values handy for the steps below.

​
Step 2: Get the board schema

Before posting data, fetch the board schema to see what fields are available and what they are named. Field names in the API must match exactly as they appear in the schema. 
curl "https://api.getaptly.com/api/aptlet/YOUR_BOARD_ID/schema" \
  -H "x-token: YOUR_API_KEY"
The response returns an array of field objects with their names and UUIDs.

​
Step 3: Post a card

Send a POST request to your board URL with a JSON body containing field names and values: 
curl -X POST "https://api.getaptly.com/api/aptlet/YOUR_BOARD_ID" \
  -H "x-token: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"Name": "John Smith", "Status": "New", "Email": "john@example.com"}'
A successful response returns the created card including its _id, which you can use to update or retrieve the card later.

​
Step 4: Retrieve the card

curl "https://api.getaptly.com/api/aptlet/YOUR_BOARD_ID/card/CARD_ID" \
  -H "x-token: YOUR_API_KEY"

​
Next steps

  • Read the Authentication guide to understand API keys and security best practices
  • Explore Pagination to retrieve large sets of cards
  • Set up Webhooks to receive real-time updates when cards change
  • Connect an AI assistant using the MCP Server