curl --request POST \
--url https://api.nexspace365.com/api/api-keys \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "CI deploy key",
"scopes": [
"shifts:read",
"facilities:read"
],
"expiresAt": "2026-08-09T00:00:00Z",
"rateLimitPerMin": 120
}
'import requests
url = "https://api.nexspace365.com/api/api-keys"
payload = {
"name": "CI deploy key",
"scopes": ["shifts:read", "facilities:read"],
"expiresAt": "2026-08-09T00:00:00Z",
"rateLimitPerMin": 120
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'CI deploy key',
scopes: ['shifts:read', 'facilities:read'],
expiresAt: '2026-08-09T00:00:00Z',
rateLimitPerMin: 120
})
};
fetch('https://api.nexspace365.com/api/api-keys', 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://api.nexspace365.com/api/api-keys",
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' => 'CI deploy key',
'scopes' => [
'shifts:read',
'facilities:read'
],
'expiresAt' => '2026-08-09T00:00:00Z',
'rateLimitPerMin' => 120
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://api.nexspace365.com/api/api-keys"
payload := strings.NewReader("{\n \"name\": \"CI deploy key\",\n \"scopes\": [\n \"shifts:read\",\n \"facilities:read\"\n ],\n \"expiresAt\": \"2026-08-09T00:00:00Z\",\n \"rateLimitPerMin\": 120\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://api.nexspace365.com/api/api-keys")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"CI deploy key\",\n \"scopes\": [\n \"shifts:read\",\n \"facilities:read\"\n ],\n \"expiresAt\": \"2026-08-09T00:00:00Z\",\n \"rateLimitPerMin\": 120\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nexspace365.com/api/api-keys")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"CI deploy key\",\n \"scopes\": [\n \"shifts:read\",\n \"facilities:read\"\n ],\n \"expiresAt\": \"2026-08-09T00:00:00Z\",\n \"rateLimitPerMin\": 120\n}"
response = http.request(request)
puts response.read_body{
"id": 15,
"name": "CI deploy key",
"prefix": "nex_live_",
"lastFour": "8f2a",
"scopes": [
"shifts:read",
"facilities:read"
],
"facilityId": null,
"ipAllowlist": [],
"rateLimitPerMin": 120,
"lastUsedAt": "2026-05-11T07:59:00Z",
"expiresAt": "2026-08-09T00:00:00Z",
"revokedAt": null,
"rotationGraceUntil": null,
"createdAt": "2026-05-11T07:00:00Z"
}{
"error": {
"message": "<string>",
"code": "<string>",
"details": {},
"suggestion": "<string>",
"retryable": true
},
"requestId": "<string>"
}{
"error": {
"message": "Invalid or revoked API key",
"code": "UNAUTHENTICATED",
"suggestion": "Send a valid `Authorization: Bearer <token>` (nex_live_/nex_pat_ key, JWT, or OAuth access token).",
"retryable": false
}
}{
"error": {
"message": "API keys cannot be managed with an API key — sign in to the dashboard",
"code": "FORBIDDEN",
"retryable": false
}
}Create API key
Mint a new API key. The plaintext token is returned exactly once in this response — store it securely. Subsequent reads expose only the prefix and last four characters.
Key management requires a dashboard session (never an API key) held by a super admin, or by an admin/manager who belongs to the platform-internal NexSpace 365 organization.
curl --request POST \
--url https://api.nexspace365.com/api/api-keys \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "CI deploy key",
"scopes": [
"shifts:read",
"facilities:read"
],
"expiresAt": "2026-08-09T00:00:00Z",
"rateLimitPerMin": 120
}
'import requests
url = "https://api.nexspace365.com/api/api-keys"
payload = {
"name": "CI deploy key",
"scopes": ["shifts:read", "facilities:read"],
"expiresAt": "2026-08-09T00:00:00Z",
"rateLimitPerMin": 120
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'CI deploy key',
scopes: ['shifts:read', 'facilities:read'],
expiresAt: '2026-08-09T00:00:00Z',
rateLimitPerMin: 120
})
};
fetch('https://api.nexspace365.com/api/api-keys', 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://api.nexspace365.com/api/api-keys",
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' => 'CI deploy key',
'scopes' => [
'shifts:read',
'facilities:read'
],
'expiresAt' => '2026-08-09T00:00:00Z',
'rateLimitPerMin' => 120
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://api.nexspace365.com/api/api-keys"
payload := strings.NewReader("{\n \"name\": \"CI deploy key\",\n \"scopes\": [\n \"shifts:read\",\n \"facilities:read\"\n ],\n \"expiresAt\": \"2026-08-09T00:00:00Z\",\n \"rateLimitPerMin\": 120\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://api.nexspace365.com/api/api-keys")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"CI deploy key\",\n \"scopes\": [\n \"shifts:read\",\n \"facilities:read\"\n ],\n \"expiresAt\": \"2026-08-09T00:00:00Z\",\n \"rateLimitPerMin\": 120\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nexspace365.com/api/api-keys")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"CI deploy key\",\n \"scopes\": [\n \"shifts:read\",\n \"facilities:read\"\n ],\n \"expiresAt\": \"2026-08-09T00:00:00Z\",\n \"rateLimitPerMin\": 120\n}"
response = http.request(request)
puts response.read_body{
"id": 15,
"name": "CI deploy key",
"prefix": "nex_live_",
"lastFour": "8f2a",
"scopes": [
"shifts:read",
"facilities:read"
],
"facilityId": null,
"ipAllowlist": [],
"rateLimitPerMin": 120,
"lastUsedAt": "2026-05-11T07:59:00Z",
"expiresAt": "2026-08-09T00:00:00Z",
"revokedAt": null,
"rotationGraceUntil": null,
"createdAt": "2026-05-11T07:00:00Z"
}{
"error": {
"message": "<string>",
"code": "<string>",
"details": {},
"suggestion": "<string>",
"retryable": true
},
"requestId": "<string>"
}{
"error": {
"message": "Invalid or revoked API key",
"code": "UNAUTHENTICATED",
"suggestion": "Send a valid `Authorization: Bearer <token>` (nex_live_/nex_pat_ key, JWT, or OAuth access token).",
"retryable": false
}
}{
"error": {
"message": "API keys cannot be managed with an API key — sign in to the dashboard",
"code": "FORBIDDEN",
"retryable": false
}
}Authorizations
JWT token authentication
Headers
Pin the request to a dated API version (e.g. 2026-05-10). Applied by app-level middleware to every /api route (server/routes/index.ts → apiVersionMiddleware), which echoes the resolved value back in the NexSpace-Version response header. Omit to get the latest version. Discover the catalog at GET /.well-known/api-versions.
^\d{4}-\d{2}-\d{2}$Replay guard for write requests. Applied by app-level middleware to every /api route (server/routes/index.ts → idempotencyMiddleware), which only acts on POST/PUT/PATCH — GET, DELETE and OPTIONS ignore the header. Re-sending the same key with an identical body within 24 hours replays the original response; the same key with a different body returns 409.
255Body
Human-readable key name
1 - 120Granted permission scopes. The enum is the canonical catalog (HEADLESS_KNOWN_SCOPES in shared/headless-scopes.ts) — the only scopes that gate real surface. The server's own validator is looser (it accepts any resource:action string matching ^[a-z_]+:[a-z*]+$, so wildcards such as shifts:* are stored), but a scope outside this catalog grants nothing on the headless surface. Authorization matches on exact scope, resource:*, or *.
1shifts:read, shifts:write, shifts:assign, staff:read, staff:write, credentials:read, credentials:verify, payroll:read, payroll:run, crm:*, facilities:read, facilities:write, integrations:write, analytics:read, facility:read, calendar:read, communications:read, marketing:read, general:read, scheduling:read, crm:read, compliance:read, crm:write, scheduling:write, communications:write, apps:read, apps:write, agents:run, agents:approve ["shifts:read", "staff:read"]
Optional expiry timestamp
Optional IPv4/IPv6 CIDR allowlist
1 <= x <= 6000Mint as personal access token (nex_pat_ prefix)
Response
API key created (plaintext token in key field — display once)
Token prefix (e.g. nex_live_, nex_test_, nex_pat_)
Last 4 characters of the token
Plaintext token — store securely, never shown again

