Master Profiles

Search master profiles

Searches identity-resolved master guest profiles (golden records merged across source systems) for the credential’s property group. Master profiles are group-scoped by design; a property drill-down narrows to entities with at least one member record at that property. Use email for an exact sub-profile email lookup, or reservation_id (Casa Layer reservation UUID, not the PMS source_id) to find the master that owns the sub-profile linked to that reservation. Each result includes its member sub-profiles (guest_profiles + guest_profile_ids). Requires scope read:guests.

GET

master-profiles

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

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

fetch('https://api.casa-layer.com/v1/master-profiles', 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/master-profiles",
  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/master-profiles"

	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/master-profiles")

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,
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "property_group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "profile_count": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "guest_profile_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "guest_profiles": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "property_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "integration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "source_id": "<string>",
          "source_version": "<string>",
          "preferences": {},
          "tags": [
            "<string>"
          ],
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "master_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "first_name": "<string>",
          "surname": "<string>",
          "email_address": "[email protected]",
          "phone_number": "<string>",
          "date_of_birth": "<string>",
          "nationality": "<string>",
          "language": "<string>",
          "address_line1": "<string>",
          "address_line2": "<string>",
          "city": "<string>",
          "state": "<string>",
          "postal_code": "<string>",
          "country": "<string>",
          "notes": [
            {
              "source_id": "<string>",
              "content": "<string>",
              "classifications": [
                "<string>"
              ],
              "is_active": true
            }
          ]
        }
      ],
      "first_name": "<string>",
      "surname": "<string>",
      "email_address": "[email protected]",
      "phone_number": "<string>",
      "date_of_birth": "<string>",
      "nationality": "<string>",
      "language": "<string>",
      "loyalty_program_status": "<string>",
      "attribute_sources": {}
    }
  ],
  "total_count": 123
}

{
  "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

string

Free-text match on name, email, or phone.

string<email>

Exact email lookup on the master or any member sub-profile (case-insensitive).

reservation_id

string<uuid>

Casa Layer reservation UUID (reservations.id). Finds the master that owns the sub-profile linked to that reservation. This is not the PMS reservation source_id — resolve that on GET /v1/reservations first.

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.

include_total

enum<string>

Opt-in total count. When true/1 and no cursor is set, includes total_count of matching master profiles only (not unclustered guests).

Available options:

0,

1,

true,

false

Response

Matching master profiles with member sub-profiles, most recently updated first.

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.

data

object[]

required

Show child attributes

total_count

integer

Count of matching master profiles when include_total is true/1 and no cursor is set; omitted otherwise.

Search master profiles

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

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

fetch('https://api.casa-layer.com/v1/master-profiles', 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/master-profiles",
  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/master-profiles"

	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/master-profiles")

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,
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "property_group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "profile_count": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "guest_profile_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "guest_profiles": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "property_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "integration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "source_id": "<string>",
          "source_version": "<string>",
          "preferences": {},
          "tags": [
            "<string>"
          ],
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "master_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "first_name": "<string>",
          "surname": "<string>",
          "email_address": "[email protected]",
          "phone_number": "<string>",
          "date_of_birth": "<string>",
          "nationality": "<string>",
          "language": "<string>",
          "address_line1": "<string>",
          "address_line2": "<string>",
          "city": "<string>",
          "state": "<string>",
          "postal_code": "<string>",
          "country": "<string>",
          "notes": [
            {
              "source_id": "<string>",
              "content": "<string>",
              "classifications": [
                "<string>"
              ],
              "is_active": true
            }
          ]
        }
      ],
      "first_name": "<string>",
      "surname": "<string>",
      "email_address": "[email protected]",
      "phone_number": "<string>",
      "date_of_birth": "<string>",
      "nationality": "<string>",
      "language": "<string>",
      "loyalty_program_status": "<string>",
      "attribute_sources": {}
    }
  ],
  "total_count": 123
}

{
  "error": "invalid_cursor"
}

{
  "error": "unauthorized"
}

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

API documentation

Endpoints

Search master profiles

Authorizations

Headers

Query Parameters

Response