Events

Guest event log

Reads the append-only guest event log. timeline (default) returns the full ordered change history. latest returns the latest delta slice per entity (DISTINCT ON) — not a merged entity snapshot. rollup is a deprecated alias for latest. Optional filters narrow by entity type, a specific entity, a guest profile, or a master profile. The event log does not accept a PMS source_id — resolve the Casa Layer ID first. Requires scope read:events.

GET

events

Guest event log

curl --request GET \
  --url https://api.casa-layer.com/v1/events \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.casa-layer.com/v1/events', 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/events",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://api.casa-layer.com/v1/events"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "next_cursor": "<string>",
  "has_more": true,
  "mode": "timeline",
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "property_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "integration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "guest_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "entity_type": "guest_profile",
      "entity_id": "<string>",
      "delta": {
        "first_name": "<string>",
        "surname": "<string>",
        "email_address": "[email protected]",
        "phone_number": "<string>",
        "date_of_birth": "2023-12-25",
        "nationality": "<string>",
        "language": "<string>",
        "preferences": {},
        "tags": [
          "<string>"
        ],
        "notes": [
          {}
        ],
        "address_line1": "<string>",
        "address_line2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postal_code": "<string>",
        "country": "<string>"
      },
      "observed_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "error": "invalid_cursor"
}

{
  "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 first-party machines and MCP clients), a partner credential access token (third-party agents; REST-only), a 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. Personal API keys and partner credentials accept X-Property-Id to drill down to one property in the group. A property-pinned API key ignores that header. MCP OAuth connector tokens authenticate the MCP server only and are rejected on these REST routes.

Headers

X-Property-Id

string<uuid>

Optional single-property drill-down. Narrows this request to one property in the caller's group. A property outside the group returns 403. Personal API keys and partner credentials accept this header. A property-pinned API key ignores it. Casa Layer sign-in tokens reject it.

Query Parameters

mode

enum<string>

default:timeline

Return the full ordered history (timeline) or the latest delta slice per entity (latest). rollup is a deprecated alias for latest.

Available options:

timeline,

latest,

rollup

entity_type

enum<string>

Filter by canonical entity type.

Available options:

guest_profile,

reservation,

transaction,

action,

loyalty_program,

membership,

review,

channel,

space

entity_id

string

Filter to a single canonical entity id.

guest_profile_id

string<uuid>

Filter to events for a single Casa Layer guest profile ID. Resolve a PMS source_id on GET /v1/guests first.

master_profile_id

string<uuid>

Filter to events on guest profiles whose master_profile_id equals this Casa Layer master profile ID. Unclustered guests (no master) do not match. Send this filter or guest_profile_id, not both.

limit

integer

default:100

Page size — rows returned per call (1–500). This is NOT a cap on the total dataset: follow next_cursor to retrieve every matching row.

Required range: 1 <= x <= 500

cursor

string

Opaque pagination token from a previous response's next_cursor. Omit for the first page. A malformed token returns 400 invalid_cursor.

Response

Event-log rows. timeline is keyset-paginated. latest (and the deprecated rollup request alias) returns a single page (next_cursor null) with the latest delta slice per entity. Response mode is always timeline or latest (never rollup).

Keyset-pagination fields present on every list/search response. When has_more is true, re-request with cursor set to next_cursor; repeat until next_cursor is null to retrieve the full result set.

next_cursor

string | null

required

Opaque cursor for the next page, or null on the last page.

has_more

boolean

required

Whether another page exists.

mode

enum<string>

required

Available options:

timeline,

latest

data

object[]

required

Show child attributes

Guest event log

curl --request GET \
  --url https://api.casa-layer.com/v1/events \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.casa-layer.com/v1/events', 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/events",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://api.casa-layer.com/v1/events"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "next_cursor": "<string>",
  "has_more": true,
  "mode": "timeline",
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "property_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "integration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "guest_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "entity_type": "guest_profile",
      "entity_id": "<string>",
      "delta": {
        "first_name": "<string>",
        "surname": "<string>",
        "email_address": "[email protected]",
        "phone_number": "<string>",
        "date_of_birth": "2023-12-25",
        "nationality": "<string>",
        "language": "<string>",
        "preferences": {},
        "tags": [
          "<string>"
        ],
        "notes": [
          {}
        ],
        "address_line1": "<string>",
        "address_line2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postal_code": "<string>",
        "country": "<string>"
      },
      "observed_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "error": "invalid_cursor"
}

{
  "error": "unauthorized"
}

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

API documentation

Endpoints

Guest event log

Authorizations

Headers

Query Parameters

Response