Get full board configuration
curl --request GET \
--url https://core-api.getaptly.com/api/board/{boardId}/configuration \
--header 'x-token: <api-key>'import requests
url = "https://core-api.getaptly.com/api/board/{boardId}/configuration"
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}/configuration', 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}/configuration",
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}/configuration"
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}/configuration")
.header("x-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://core-api.getaptly.com/api/board/{boardId}/configuration")
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": {
"fields": [
{
"uuid": "<string>",
"name": "<string>",
"type": "<string>",
"position": 123,
"optional": true,
"archived": true
}
],
"automations": [
{
"uuid": "<string>",
"title": "<string>",
"archived": true,
"destinationBoardUuid": "<string>",
"sourceBoardUuid": "<string>",
"runMode": "<string>",
"segment": "<unknown>",
"timeOfDay": 123
}
],
"options": {
"minCallDuration": 123,
"boardEmailOnlyParsedCards": true,
"displayFieldNames": true,
"agingIndicator": true,
"applicationFeatures": true,
"applicationLinking": true,
"defaultContactType": "<string>",
"updateBadgeField": "<string>"
},
"tabViews": [
{
"uuid": "<string>",
"name": "<string>",
"url": "<string>",
"icon": "<string>",
"embedSource": "<string>",
"type": "<string>"
}
],
"workflows": [
{}
],
"groups": [
{}
],
"shares": {
"acl": [
{}
]
},
"theme": {
"name": "<string>",
"cardName": "<string>",
"color": "<string>",
"icon": "<string>",
"description": "<string>",
"shortCode": "<string>"
},
"filters": [
{}
]
}
}Board
Get full board configuration
Returns all configuration sections for the board in a single response: fields, automations, options, tabViews, workflows, groups, shares, theme, and filters.
GET
/
api
/
board
/
{boardId}
/
configuration
Get full board configuration
curl --request GET \
--url https://core-api.getaptly.com/api/board/{boardId}/configuration \
--header 'x-token: <api-key>'import requests
url = "https://core-api.getaptly.com/api/board/{boardId}/configuration"
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}/configuration', 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}/configuration",
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}/configuration"
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}/configuration")
.header("x-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://core-api.getaptly.com/api/board/{boardId}/configuration")
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": {
"fields": [
{
"uuid": "<string>",
"name": "<string>",
"type": "<string>",
"position": 123,
"optional": true,
"archived": true
}
],
"automations": [
{
"uuid": "<string>",
"title": "<string>",
"archived": true,
"destinationBoardUuid": "<string>",
"sourceBoardUuid": "<string>",
"runMode": "<string>",
"segment": "<unknown>",
"timeOfDay": 123
}
],
"options": {
"minCallDuration": 123,
"boardEmailOnlyParsedCards": true,
"displayFieldNames": true,
"agingIndicator": true,
"applicationFeatures": true,
"applicationLinking": true,
"defaultContactType": "<string>",
"updateBadgeField": "<string>"
},
"tabViews": [
{
"uuid": "<string>",
"name": "<string>",
"url": "<string>",
"icon": "<string>",
"embedSource": "<string>",
"type": "<string>"
}
],
"workflows": [
{}
],
"groups": [
{}
],
"shares": {
"acl": [
{}
]
},
"theme": {
"name": "<string>",
"cardName": "<string>",
"color": "<string>",
"icon": "<string>",
"description": "<string>",
"shortCode": "<string>"
},
"filters": [
{}
]
}
}⌘I