List cards
curl --request GET \
--url https://core-api.getaptly.com/api/board/{boardId} \
--header 'x-token: <api-key>'import requests
url = "https://core-api.getaptly.com/api/board/{boardId}"
headers = {"x-token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-token': '<api-key>'}};
fetch('https://core-api.getaptly.com/api/board/{boardId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://core-api.getaptly.com/api/board/{boardId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://core-api.getaptly.com/api/board/{boardId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://core-api.getaptly.com/api/board/{boardId}")
.header("x-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://core-api.getaptly.com/api/board/{boardId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"cardId": "<string>",
"boardUuid": "<string>",
"archived": true,
"assignee": "<string>",
"lastActivity": {
"content": "<string>",
"type": "<string>",
"direction": "in",
"publishedAt": "2023-11-07T05:31:56Z",
"conversationUrl": "<string>"
}
}
],
"count": 123,
"page": 123,
"pageSize": 123
}Cards
List cards
Returns a paginated list of cards on the board.
Field values are keyed by field UUID — use the schema endpoint to map keys to labels.
Money fields are returned as { amount, currency } where amount is a decimal.
All filter params are optional and ANDed together.
GET
/
api
/
board
/
{boardId}
List cards
curl --request GET \
--url https://core-api.getaptly.com/api/board/{boardId} \
--header 'x-token: <api-key>'import requests
url = "https://core-api.getaptly.com/api/board/{boardId}"
headers = {"x-token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-token': '<api-key>'}};
fetch('https://core-api.getaptly.com/api/board/{boardId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://core-api.getaptly.com/api/board/{boardId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://core-api.getaptly.com/api/board/{boardId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://core-api.getaptly.com/api/board/{boardId}")
.header("x-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://core-api.getaptly.com/api/board/{boardId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"cardId": "<string>",
"boardUuid": "<string>",
"archived": true,
"assignee": "<string>",
"lastActivity": {
"content": "<string>",
"type": "<string>",
"direction": "in",
"publishedAt": "2023-11-07T05:31:56Z",
"conversationUrl": "<string>"
}
}
],
"count": 123,
"page": 123,
"pageSize": 123
}Authorizations
ApiKeyHeaderDelegateToken
Path Parameters
The board's UUID.
Query Parameters
Zero-based page number.
Required range:
0 <= x <= 9999Number of cards per page.
Required range:
1 <= x <= 1000Only return cards updated after this ISO timestamp.
Include archived cards.
Only return cards where references.value contains this ID.
Resolves the email to contact IDs, then filters cards referencing those contacts.
Full-text autocomplete search on card title using the Atlas Search index.
Filter cards by assignee user ID.