Create the first administrator
curl --request POST \
--url https://posted-api.example.com/api/auth/setup \
--header 'Content-Type: application/json' \
--data '
{
"setupSecret": "<string>",
"workspaceName": "<string>",
"name": "<string>",
"email": "jsmith@example.com",
"password": "<string>",
"timeZone": "<string>"
}
'import requests
url = "https://posted-api.example.com/api/auth/setup"
payload = {
"setupSecret": "<string>",
"workspaceName": "<string>",
"name": "<string>",
"email": "jsmith@example.com",
"password": "<string>",
"timeZone": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
setupSecret: '<string>',
workspaceName: '<string>',
name: '<string>',
email: 'jsmith@example.com',
password: '<string>',
timeZone: '<string>'
})
};
fetch('https://posted-api.example.com/api/auth/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://posted-api.example.com/api/auth/setup",
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([
'setupSecret' => '<string>',
'workspaceName' => '<string>',
'name' => '<string>',
'email' => 'jsmith@example.com',
'password' => '<string>',
'timeZone' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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://posted-api.example.com/api/auth/setup"
payload := strings.NewReader("{\n \"setupSecret\": \"<string>\",\n \"workspaceName\": \"<string>\",\n \"name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"password\": \"<string>\",\n \"timeZone\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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://posted-api.example.com/api/auth/setup")
.header("Content-Type", "application/json")
.body("{\n \"setupSecret\": \"<string>\",\n \"workspaceName\": \"<string>\",\n \"name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"password\": \"<string>\",\n \"timeZone\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://posted-api.example.com/api/auth/setup")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"setupSecret\": \"<string>\",\n \"workspaceName\": \"<string>\",\n \"name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"password\": \"<string>\",\n \"timeZone\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"user": {
"id": "66666666-6666-4666-8666-666666666666",
"name": "Alex Morgan",
"email": "alex@example.test",
"role": "admin",
"timeZone": "UTC",
"emailVerified": true,
"dateFormat": "day-short-month-year",
"timeFormat": "24-hour",
"notificationPreferences": {
"assignments": true,
"mentions": true
},
"passkeyCount": 0
},
"workspace": {
"id": "55555555-5555-4555-8555-555555555555",
"name": "Studio team",
"createdAt": "2027-01-18T09:30:00.000Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>"
}
}Create the first administrator
Requires the unused installation setup secret. Creates the team and verified first administrator, then sets a session cookie. A configured installation rejects another setup.
POST
/
api
/
auth
/
setup
Create the first administrator
curl --request POST \
--url https://posted-api.example.com/api/auth/setup \
--header 'Content-Type: application/json' \
--data '
{
"setupSecret": "<string>",
"workspaceName": "<string>",
"name": "<string>",
"email": "jsmith@example.com",
"password": "<string>",
"timeZone": "<string>"
}
'import requests
url = "https://posted-api.example.com/api/auth/setup"
payload = {
"setupSecret": "<string>",
"workspaceName": "<string>",
"name": "<string>",
"email": "jsmith@example.com",
"password": "<string>",
"timeZone": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
setupSecret: '<string>',
workspaceName: '<string>',
name: '<string>',
email: 'jsmith@example.com',
password: '<string>',
timeZone: '<string>'
})
};
fetch('https://posted-api.example.com/api/auth/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://posted-api.example.com/api/auth/setup",
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([
'setupSecret' => '<string>',
'workspaceName' => '<string>',
'name' => '<string>',
'email' => 'jsmith@example.com',
'password' => '<string>',
'timeZone' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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://posted-api.example.com/api/auth/setup"
payload := strings.NewReader("{\n \"setupSecret\": \"<string>\",\n \"workspaceName\": \"<string>\",\n \"name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"password\": \"<string>\",\n \"timeZone\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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://posted-api.example.com/api/auth/setup")
.header("Content-Type", "application/json")
.body("{\n \"setupSecret\": \"<string>\",\n \"workspaceName\": \"<string>\",\n \"name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"password\": \"<string>\",\n \"timeZone\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://posted-api.example.com/api/auth/setup")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"setupSecret\": \"<string>\",\n \"workspaceName\": \"<string>\",\n \"name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"password\": \"<string>\",\n \"timeZone\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"user": {
"id": "66666666-6666-4666-8666-666666666666",
"name": "Alex Morgan",
"email": "alex@example.test",
"role": "admin",
"timeZone": "UTC",
"emailVerified": true,
"dateFormat": "day-short-month-year",
"timeFormat": "24-hour",
"notificationPreferences": {
"assignments": true,
"mentions": true
},
"passkeyCount": 0
},
"workspace": {
"id": "55555555-5555-4555-8555-555555555555",
"name": "Studio team",
"createdAt": "2027-01-18T09:30:00.000Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>"
}
}No signed-in session is required. Endpoint-specific tokens, setup secrets or challenges may still be required.
Requires the unused installation setup secret. Creates the team and verified first administrator, then sets a session cookie. A configured installation rejects another setup.
Request conventions · API keys · MCP connections
Body
application/json
Required string length:
1 - 1024Required string length:
1 - 120Required string length:
1 - 120Maximum string length:
320Pattern:
^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$Required string length:
15 - 1024Available options:
day-short-month-year, short-month-day-year, year-month-day, day-month-year, month-day-year Available options:
24-hour, 12-hour, 24-hour-seconds, 12-hour-seconds Required string length:
1 - 100Was this page helpful?
