curl --request GET \
--url https://www.closient.com/byos/api/setup/import requests
url = "https://www.closient.com/byos/api/setup/"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://www.closient.com/byos/api/setup/', 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://www.closient.com/byos/api/setup/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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://www.closient.com/byos/api/setup/"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://www.closient.com/byos/api/setup/")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.closient.com/byos/api/setup/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"api_key": "d51229662e86a29fe6ab11a4ca1a4a41d141fc8b",
"filename": "closient-A1B2C3-3f9a2c1d8e.png",
"friendly_id": "A1B2C3",
"image_url": "https://www.closient.com/byos/devices/A1B2C3/image.png",
"message": "",
"status": 200
}{}{
"type": "https://closient.com/docs/errors/not_found",
"title": "Not Found",
"status": 404,
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"timestamp": "2026-03-31T12:00:00+00:00"
}{
"type": "https://closient.com/docs/errors/not_found",
"title": "Not Found",
"status": 404,
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"timestamp": "2026-03-31T12:00:00+00:00"
}{
"type": "https://closient.com/docs/errors/not_found",
"title": "Not Found",
"status": 404,
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"timestamp": "2026-03-31T12:00:00+00:00"
}TRMNL device setup
Called by TRMNL firmware on first boot. The device presents its MAC in the ID header; the server responds with an api_key (used as Access-Token on every subsequent call), a 6-char friendly_id, the URL of the device’s first image, and a suggested filename for local caching.
If the MAC has never been seen, an unclaimed BYOSDevice row is created — the device starts in the unclaimed state and renders the BYOS fallback image until an operator links it to an organization.
Auth: unauthenticated. The TRMNL firmware doesn’t have an Access-Token yet at this call.
200— setup succeeded; device may begin polling/api/display.400— theIDheader is missing or not a 12-char hex MAC.
curl --request GET \
--url https://www.closient.com/byos/api/setup/import requests
url = "https://www.closient.com/byos/api/setup/"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://www.closient.com/byos/api/setup/', 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://www.closient.com/byos/api/setup/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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://www.closient.com/byos/api/setup/"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://www.closient.com/byos/api/setup/")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.closient.com/byos/api/setup/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"api_key": "d51229662e86a29fe6ab11a4ca1a4a41d141fc8b",
"filename": "closient-A1B2C3-3f9a2c1d8e.png",
"friendly_id": "A1B2C3",
"image_url": "https://www.closient.com/byos/devices/A1B2C3/image.png",
"message": "",
"status": 200
}{}{
"type": "https://closient.com/docs/errors/not_found",
"title": "Not Found",
"status": 404,
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"timestamp": "2026-03-31T12:00:00+00:00"
}{
"type": "https://closient.com/docs/errors/not_found",
"title": "Not Found",
"status": 404,
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"timestamp": "2026-03-31T12:00:00+00:00"
}{
"type": "https://closient.com/docs/errors/not_found",
"title": "Not Found",
"status": 404,
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"timestamp": "2026-03-31T12:00:00+00:00"
}Response
OK
Response to GET /api/setup/.
The TRMNL firmware persists api_key to flash and uses it on every
subsequent call. image_url is the first image to paint — for an
unclaimed device this is the fallback "register me" screen.