SQL

Run read-only SQL

Executes a read-only SQL statement over the public data model (guest_profiles, reservations, actions, loyalty_programs, memberships, reviews, channels, spaces, master_profiles, guest_event_log, integrations, transactions, consents). Queries run as a least-privilege database role under row-level security scoped to the caller’s group (and single property when drilled down), so a query can never read another tenant’s rows — even without a WHERE clause. Writes are rejected. Requires scope read:sql.

POST

sql

Run read-only SQL

curl --request POST \
  --url https://api.casa-layer.com/v1/sql \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sql": "SELECT first_name, surname FROM guest_profiles ORDER BY created_at DESC LIMIT 10"
}
'

import requests

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

payload = { "sql": "SELECT first_name, surname FROM guest_profiles ORDER BY created_at DESC LIMIT 10" }
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({
    sql: 'SELECT first_name, surname FROM guest_profiles ORDER BY created_at DESC LIMIT 10'
  })
};

fetch('https://api.casa-layer.com/v1/sql', 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/sql",
  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([
    'sql' => 'SELECT first_name, surname FROM guest_profiles ORDER BY created_at DESC LIMIT 10'
  ]),
  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/sql"

	payload := strings.NewReader("{\n  \"sql\": \"SELECT first_name, surname FROM guest_profiles ORDER BY created_at DESC LIMIT 10\"\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/sql")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"sql\": \"SELECT first_name, surname FROM guest_profiles ORDER BY created_at DESC LIMIT 10\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"sql\": \"SELECT first_name, surname FROM guest_profiles ORDER BY created_at DESC LIMIT 10\"\n}"

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

{
  "columns": [
    "<string>"
  ],
  "rows": [
    {}
  ],
  "truncated": true,
  "rowCount": 123
}

{
  "error": "<string>",
  "scope": "<string>",
  "detail": "<string>"
}

{
  "error": "unauthorized"
}

{
  "error": "forbidden",
  "scope": "read:guests"
}

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.

Headers

X-Organization-Id

string

Active WorkOS organization (property group). Optional cross-check for session (JWT) auth: when sent it must equal the token's verified org_id claim, else 403. The org is taken from the claim, not this header. Ignored for API keys and static tokens.

X-Property-Id

string<uuid>

Optional single-property drill-down. When set, narrows the request to this property; it must belong to the caller's group, else 403. A property-pinned API key is already narrowed and ignores this header.

Body

application/json

sql

string

required

Example:

"SELECT first_name, surname FROM guest_profiles ORDER BY created_at DESC LIMIT 10"

Response

Query results.

columns

string[]

required

rows

object[]

required

truncated

boolean

required

rowCount

integer

required

Run read-only SQL

curl --request POST \
  --url https://api.casa-layer.com/v1/sql \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sql": "SELECT first_name, surname FROM guest_profiles ORDER BY created_at DESC LIMIT 10"
}
'

import requests

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

payload = { "sql": "SELECT first_name, surname FROM guest_profiles ORDER BY created_at DESC LIMIT 10" }
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({
    sql: 'SELECT first_name, surname FROM guest_profiles ORDER BY created_at DESC LIMIT 10'
  })
};

fetch('https://api.casa-layer.com/v1/sql', 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/sql",
  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([
    'sql' => 'SELECT first_name, surname FROM guest_profiles ORDER BY created_at DESC LIMIT 10'
  ]),
  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/sql"

	payload := strings.NewReader("{\n  \"sql\": \"SELECT first_name, surname FROM guest_profiles ORDER BY created_at DESC LIMIT 10\"\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/sql")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"sql\": \"SELECT first_name, surname FROM guest_profiles ORDER BY created_at DESC LIMIT 10\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"sql\": \"SELECT first_name, surname FROM guest_profiles ORDER BY created_at DESC LIMIT 10\"\n}"

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

{
  "columns": [
    "<string>"
  ],
  "rows": [
    {}
  ],
  "truncated": true,
  "rowCount": 123
}

{
  "error": "<string>",
  "scope": "<string>",
  "detail": "<string>"
}

{
  "error": "unauthorized"
}

{
  "error": "forbidden",
  "scope": "read:guests"
}

API documentation

Endpoints

Run read-only SQL

Authorizations

Headers

Body

Response