Properties

Provision a tenant (server-side WorkOS org creation)

Bootstraps a property group + first property for the caller. Requires a WorkOS session token (SPA surface).

Two paths, chosen from the verified token claims:

Org-less (new self-serve user): the server creates a WorkOS organization, adds the caller as owner, then bootstraps the tenant. Send organization_name. Idempotent per user — an existing membership is reused, and a second call returns 409.
Org-present (invited admin finishing setup): the org comes from the token’s org_id claim (owner/admin only); organization_name is ignored.

After a 201, the SPA re-mints its token against the returned organization_id so the new org claim is present on the next request.

POST

onboarding

Provision a tenant (server-side WorkOS org creation)

curl --request POST \
  --url https://api.casa-layer.com/v1/onboarding \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "property_name": "The Strand Hotel",
  "organization_name": "Acme Hospitality Group",
  "currency": "USD",
  "timezone": "Europe/London"
}
'

import requests

url = "https://api.casa-layer.com/v1/onboarding"

payload = {
    "property_name": "The Strand Hotel",
    "organization_name": "Acme Hospitality Group",
    "currency": "USD",
    "timezone": "Europe/London"
}
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({
    property_name: 'The Strand Hotel',
    organization_name: 'Acme Hospitality Group',
    currency: 'USD',
    timezone: 'Europe/London'
  })
};

fetch('https://api.casa-layer.com/v1/onboarding', 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.casa-layer.com/v1/onboarding",
  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([
    'property_name' => 'The Strand Hotel',
    'organization_name' => 'Acme Hospitality Group',
    'currency' => 'USD',
    'timezone' => 'Europe/London'
  ]),
  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.casa-layer.com/v1/onboarding"

	payload := strings.NewReader("{\n  \"property_name\": \"The Strand Hotel\",\n  \"organization_name\": \"Acme Hospitality Group\",\n  \"currency\": \"USD\",\n  \"timezone\": \"Europe/London\"\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.casa-layer.com/v1/onboarding")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"property_name\": \"The Strand Hotel\",\n  \"organization_name\": \"Acme Hospitality Group\",\n  \"currency\": \"USD\",\n  \"timezone\": \"Europe/London\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.casa-layer.com/v1/onboarding")

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  \"property_name\": \"The Strand Hotel\",\n  \"organization_name\": \"Acme Hospitality Group\",\n  \"currency\": \"USD\",\n  \"timezone\": \"Europe/London\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "organization_id": "org_01ABC...",
    "property_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "property_group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "error": "unauthorized"
}

Authorizations

Authorization

string

header

required

Authorization: Bearer <token>. Token types resolve to the same scoped credential: a user-generated API key (casa_…, from Account settings — recommended for machines and MCP clients), a WorkOS AuthKit session JWT (the web app; org and role come from verified token claims), or a static token. API keys are group-scoped, optionally pinned to one property at creation. MCP OAuth connector tokens authenticate the MCP server only and are rejected on these REST routes.

Body

application/json

property_name

string

required

Example:

"The Strand Hotel"

organization_name

string

Required on the org-less path; ignored when the token already carries an org.

Example:

"Acme Hospitality Group"

currency

string

Example:

"USD"

timezone

string

Example:

"Europe/London"

Response

Tenant created.

data

object

required

Show child attributes

Provision a tenant (server-side WorkOS org creation)

curl --request POST \
  --url https://api.casa-layer.com/v1/onboarding \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "property_name": "The Strand Hotel",
  "organization_name": "Acme Hospitality Group",
  "currency": "USD",
  "timezone": "Europe/London"
}
'

import requests

url = "https://api.casa-layer.com/v1/onboarding"

payload = {
    "property_name": "The Strand Hotel",
    "organization_name": "Acme Hospitality Group",
    "currency": "USD",
    "timezone": "Europe/London"
}
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({
    property_name: 'The Strand Hotel',
    organization_name: 'Acme Hospitality Group',
    currency: 'USD',
    timezone: 'Europe/London'
  })
};

fetch('https://api.casa-layer.com/v1/onboarding', 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.casa-layer.com/v1/onboarding",
  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([
    'property_name' => 'The Strand Hotel',
    'organization_name' => 'Acme Hospitality Group',
    'currency' => 'USD',
    'timezone' => 'Europe/London'
  ]),
  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.casa-layer.com/v1/onboarding"

	payload := strings.NewReader("{\n  \"property_name\": \"The Strand Hotel\",\n  \"organization_name\": \"Acme Hospitality Group\",\n  \"currency\": \"USD\",\n  \"timezone\": \"Europe/London\"\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.casa-layer.com/v1/onboarding")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"property_name\": \"The Strand Hotel\",\n  \"organization_name\": \"Acme Hospitality Group\",\n  \"currency\": \"USD\",\n  \"timezone\": \"Europe/London\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.casa-layer.com/v1/onboarding")

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  \"property_name\": \"The Strand Hotel\",\n  \"organization_name\": \"Acme Hospitality Group\",\n  \"currency\": \"USD\",\n  \"timezone\": \"Europe/London\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "organization_id": "org_01ABC...",
    "property_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "property_group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "error": "unauthorized"
}

API documentation

Endpoints

Provision a tenant (server-side WorkOS org creation)

Authorizations

Body

Response