Master Profiles

List master profile directory (offset pages)

Returns a unified directory of clustered master profiles plus unclustered singleton guests (master_profile_id is null), ordered for SPA page-number navigation. Prefer keyset GET /v1/master-profiles for deep sequential walks. When q is set, only clustered masters are returned. total_count is included by default when offset=0 (or when include_total=1); omit or set include_total=0 on later pages to skip COUNT. Requires scope read:guests.

GET

master-profiles

directory

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

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

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

	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/directory")

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

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "kind": "clustered",
      "profile_count": 123,
      "updated_at": "2023-11-07T05:31:56Z",
      "first_name": "<string>",
      "surname": "<string>",
      "email_address": "[email protected]",
      "phone_number": "<string>",
      "attribute_sources": {},
      "integration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "has_more": true,
  "next_offset": 123,
  "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 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-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.

Query Parameters

string

Free-text match on master name, email, or phone (masters only).

offset

integer

default:0

Zero-based row offset (clamped to 50,000; deep offsets degrade).

Required range: x >= 0

sort_by

enum<string>

default:updated_at

Allowlisted sort column.

Available options:

updated_at,

name,

email,

profile_count

sort_dir

enum<string>

default:desc

Available options:

asc,

desc

include_total

enum<string>

When true/1, include total_count. Defaults to true when offset is 0, false otherwise.

Available options:

0,

1,

true,

false

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

Response

Directory page with optional total_count.

data

object[]

required

Show child attributes

has_more

boolean

required

next_offset

integer | null

required

Offset for the next page, or null when exhausted.

total_count

integer

Full filtered directory size (when counted).

List master profile directory (offset pages)

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

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

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

	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/directory")

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

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "kind": "clustered",
      "profile_count": 123,
      "updated_at": "2023-11-07T05:31:56Z",
      "first_name": "<string>",
      "surname": "<string>",
      "email_address": "[email protected]",
      "phone_number": "<string>",
      "attribute_sources": {},
      "integration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "has_more": true,
  "next_offset": 123,
  "total_count": 123
}

{
  "error": "invalid_cursor"
}

{
  "error": "unauthorized"
}

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

API documentation

Endpoints

List master profile directory (offset pages)

Authorizations

Headers

Query Parameters

Response