curl --request POST \
--url https://core-api.getaptly.com/api/boards \
--header 'Content-Type: application/json' \
--header 'x-token: <api-key>' \
--data '
{
"name": "Maintenance Requests",
"boardType": "ticket",
"stages": [
{
"label": "Backlog"
},
{
"label": "In Progress",
"color": "#f1b44c"
},
{
"label": "Done",
"closed": true
}
],
"fields": [
{
"name": "Priority",
"type": "singleselect",
"data": [
{
"label": "Low"
},
{
"label": "Medium"
},
{
"label": "High"
}
]
}
]
}
'import requests
url = "https://core-api.getaptly.com/api/boards"
payload = {
"name": "Maintenance Requests",
"boardType": "ticket",
"stages": [
{ "label": "Backlog" },
{
"label": "In Progress",
"color": "#f1b44c"
},
{
"label": "Done",
"closed": True
}
],
"fields": [
{
"name": "Priority",
"type": "singleselect",
"data": [{ "label": "Low" }, { "label": "Medium" }, { "label": "High" }]
}
]
}
headers = {
"x-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Maintenance Requests',
boardType: 'ticket',
stages: [
{label: 'Backlog'},
{label: 'In Progress', color: '#f1b44c'},
{label: 'Done', closed: true}
],
fields: [
{
name: 'Priority',
type: 'singleselect',
data: [{label: 'Low'}, {label: 'Medium'}, {label: 'High'}]
}
]
})
};
fetch('https://core-api.getaptly.com/api/boards', 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/boards",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Maintenance Requests',
'boardType' => 'ticket',
'stages' => [
[
'label' => 'Backlog'
],
[
'label' => 'In Progress',
'color' => '#f1b44c'
],
[
'label' => 'Done',
'closed' => true
]
],
'fields' => [
[
'name' => 'Priority',
'type' => 'singleselect',
'data' => [
[
'label' => 'Low'
],
[
'label' => 'Medium'
],
[
'label' => 'High'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://core-api.getaptly.com/api/boards"
payload := strings.NewReader("{\n \"name\": \"Maintenance Requests\",\n \"boardType\": \"ticket\",\n \"stages\": [\n {\n \"label\": \"Backlog\"\n },\n {\n \"label\": \"In Progress\",\n \"color\": \"#f1b44c\"\n },\n {\n \"label\": \"Done\",\n \"closed\": true\n }\n ],\n \"fields\": [\n {\n \"name\": \"Priority\",\n \"type\": \"singleselect\",\n \"data\": [\n {\n \"label\": \"Low\"\n },\n {\n \"label\": \"Medium\"\n },\n {\n \"label\": \"High\"\n }\n ]\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://core-api.getaptly.com/api/boards")
.header("x-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Maintenance Requests\",\n \"boardType\": \"ticket\",\n \"stages\": [\n {\n \"label\": \"Backlog\"\n },\n {\n \"label\": \"In Progress\",\n \"color\": \"#f1b44c\"\n },\n {\n \"label\": \"Done\",\n \"closed\": true\n }\n ],\n \"fields\": [\n {\n \"name\": \"Priority\",\n \"type\": \"singleselect\",\n \"data\": [\n {\n \"label\": \"Low\"\n },\n {\n \"label\": \"Medium\"\n },\n {\n \"label\": \"High\"\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://core-api.getaptly.com/api/boards")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Maintenance Requests\",\n \"boardType\": \"ticket\",\n \"stages\": [\n {\n \"label\": \"Backlog\"\n },\n {\n \"label\": \"In Progress\",\n \"color\": \"#f1b44c\"\n },\n {\n \"label\": \"Done\",\n \"closed\": true\n }\n ],\n \"fields\": [\n {\n \"name\": \"Priority\",\n \"type\": \"singleselect\",\n \"data\": [\n {\n \"label\": \"Low\"\n },\n {\n \"label\": \"Medium\"\n },\n {\n \"label\": \"High\"\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"uuid": "<string>",
"name": "<string>",
"endpoints": [
{
"method": "<string>",
"url": "<string>",
"description": "<string>"
}
]
}
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "One or more fields are invalid",
"meta": {
"issues": [
{
"field": "to.0.value",
"code": "invalid_format",
"message": "must be a valid email address"
}
]
}
},
"requestId": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Create a board
Creates a new board. Requires the key’s dedicated “Create Boards” access toggle to be
enabled, in addition to insert permission — unlike the API key’s other access
toggles, this one defaults off and must be explicitly turned on in Setup → Developer.
A stage field is always added automatically (a board can’t render a Kanban/pipeline
view without one) — ticket boards default to To Do / In Progress / Done, deal
boards to the standard Aptly deal pipeline. To use your own pipeline instead, pass
stages. You can add, reorder and recolor stages later with PUT .../configuration/fields/stage. stage, along with a handful of other
reserved keys (name, dueAt, relatedContacts, and every card-document system key
such as _id, companyId, archived), can’t be used as a custom field’s uuid.
Only a safe, self-contained subset of Aptly’s field types may be used for custom
fields — relational types that reference other boards (e.g. relatedAptlets,
mirror) and system/computed types the backend manages itself (e.g. stageselect,
calculation) are rejected, since a freshly created board has nothing valid for them
to point at yet.
The key that creates a board keeps access to it. Even if the key is limited to specific
boards (so the new board is not on its list), it can read and write the board’s cards, see
it in GET /api/boards, and - with the update permission but without the “Edit Boards”
toggle - add, change and remove its fields, change its theme and archive it. This applies
only to boards created through this endpoint by that key, and ends when the key is deleted.
It does not extend to other boards, to creating Automations (which has its own toggle), or to
Tasks, Files and mirror-field links to other boards, which still follow the key’s board list.
Boards created before this change are not affected.
curl --request POST \
--url https://core-api.getaptly.com/api/boards \
--header 'Content-Type: application/json' \
--header 'x-token: <api-key>' \
--data '
{
"name": "Maintenance Requests",
"boardType": "ticket",
"stages": [
{
"label": "Backlog"
},
{
"label": "In Progress",
"color": "#f1b44c"
},
{
"label": "Done",
"closed": true
}
],
"fields": [
{
"name": "Priority",
"type": "singleselect",
"data": [
{
"label": "Low"
},
{
"label": "Medium"
},
{
"label": "High"
}
]
}
]
}
'import requests
url = "https://core-api.getaptly.com/api/boards"
payload = {
"name": "Maintenance Requests",
"boardType": "ticket",
"stages": [
{ "label": "Backlog" },
{
"label": "In Progress",
"color": "#f1b44c"
},
{
"label": "Done",
"closed": True
}
],
"fields": [
{
"name": "Priority",
"type": "singleselect",
"data": [{ "label": "Low" }, { "label": "Medium" }, { "label": "High" }]
}
]
}
headers = {
"x-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Maintenance Requests',
boardType: 'ticket',
stages: [
{label: 'Backlog'},
{label: 'In Progress', color: '#f1b44c'},
{label: 'Done', closed: true}
],
fields: [
{
name: 'Priority',
type: 'singleselect',
data: [{label: 'Low'}, {label: 'Medium'}, {label: 'High'}]
}
]
})
};
fetch('https://core-api.getaptly.com/api/boards', 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/boards",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Maintenance Requests',
'boardType' => 'ticket',
'stages' => [
[
'label' => 'Backlog'
],
[
'label' => 'In Progress',
'color' => '#f1b44c'
],
[
'label' => 'Done',
'closed' => true
]
],
'fields' => [
[
'name' => 'Priority',
'type' => 'singleselect',
'data' => [
[
'label' => 'Low'
],
[
'label' => 'Medium'
],
[
'label' => 'High'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://core-api.getaptly.com/api/boards"
payload := strings.NewReader("{\n \"name\": \"Maintenance Requests\",\n \"boardType\": \"ticket\",\n \"stages\": [\n {\n \"label\": \"Backlog\"\n },\n {\n \"label\": \"In Progress\",\n \"color\": \"#f1b44c\"\n },\n {\n \"label\": \"Done\",\n \"closed\": true\n }\n ],\n \"fields\": [\n {\n \"name\": \"Priority\",\n \"type\": \"singleselect\",\n \"data\": [\n {\n \"label\": \"Low\"\n },\n {\n \"label\": \"Medium\"\n },\n {\n \"label\": \"High\"\n }\n ]\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://core-api.getaptly.com/api/boards")
.header("x-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Maintenance Requests\",\n \"boardType\": \"ticket\",\n \"stages\": [\n {\n \"label\": \"Backlog\"\n },\n {\n \"label\": \"In Progress\",\n \"color\": \"#f1b44c\"\n },\n {\n \"label\": \"Done\",\n \"closed\": true\n }\n ],\n \"fields\": [\n {\n \"name\": \"Priority\",\n \"type\": \"singleselect\",\n \"data\": [\n {\n \"label\": \"Low\"\n },\n {\n \"label\": \"Medium\"\n },\n {\n \"label\": \"High\"\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://core-api.getaptly.com/api/boards")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Maintenance Requests\",\n \"boardType\": \"ticket\",\n \"stages\": [\n {\n \"label\": \"Backlog\"\n },\n {\n \"label\": \"In Progress\",\n \"color\": \"#f1b44c\"\n },\n {\n \"label\": \"Done\",\n \"closed\": true\n }\n ],\n \"fields\": [\n {\n \"name\": \"Priority\",\n \"type\": \"singleselect\",\n \"data\": [\n {\n \"label\": \"Low\"\n },\n {\n \"label\": \"Medium\"\n },\n {\n \"label\": \"High\"\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"uuid": "<string>",
"name": "<string>",
"endpoints": [
{
"method": "<string>",
"url": "<string>",
"description": "<string>"
}
]
}
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "One or more fields are invalid",
"meta": {
"issues": [
{
"field": "to.0.value",
"code": "invalid_format",
"message": "must be a valid email address"
}
]
}
},
"requestId": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}