> ## Documentation Index > Fetch the complete documentation index at: https://docs.casa-layer.com/llms.txt > Use this file to discover all available pages before exploring further. # 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`. ## OpenAPI ````yaml /api-reference/openapi.yaml get /v1/master-profiles/directory openapi: 3.1.0 info: title: Casa API version: 1.0.0 description: > Headless, read-only access to the guest context layer — the entire canonical data model over HTTP. Every endpoint is **scoped by the credential**: the default scope is the caller's property group, returning data across all of its properties. Auth sources resolve to the same credential: a user-generated **API key** (`casa_…`, created in Account settings — the recommended method for machines), a WorkOS AuthKit session JWT (the web app; org and role come from verified token claims), or a static token. (The MCP server also accepts read-only OAuth connector tokens, but those are rejected on these REST routes.) Send `X-Property-Id` to drill down into a single property; API keys can also be pinned to one property at creation. Tenant isolation holds by construction. Integration-management endpoints write connection *metadata* only and are session-only; canonical guest data enters exclusively through the connector workers and the ingest pipeline. The Model Context Protocol (MCP) server is exposed separately at `/mcp` and is documented under **MCP Server** in the guides — it is not a REST endpoint and is intentionally omitted from this reference. It accepts the same API keys. servers: - url: https://api.casa-layer.com description: Production Cloudflare Worker security: - bearerAuth: [] tags: - name: System description: Liveness, health, and the public welcome page. - name: Guests description: Canonical guest profiles as ingested from each source system. - name: Master Profiles description: >- Identity-resolved golden records — one entity per real guest, merged across sources and properties. - name: Reservations description: >- Reservation records linked to guest profiles, searchable by status, stay window, and channel. - name: Transactions description: >- Revenue lines (Pace Transactions V2–shaped) linked to guests and optionally reservations. - name: Consents description: > Contact-grain consent observations (contact method + value × purpose). Rows store decisive signals only (granted/withdrawn/denied); absence of a row means unknown / not eligible. Effective eligibility within a property group is the most restrictive status among stored observations for the same contact×purpose (withdrawn/denied beat granted). - name: Tables description: > Attio-style ops tables — curated or filter-defined containers for day-to-day work inside Casa. Tables are not consent eligibility records and not marketing segments; campaign audiences stay in downstream ESP tools (Klaviyo, Mailchimp, and peers). - name: Actions description: Guest actions (purchases, visits, and other tracked events). - name: Events description: >- The append-only guest event log — full change history or latest delta slice per entity. - name: Reviews description: Guest reviews with free-text search and an aggregate summary. - name: Loyalty description: Loyalty programs and member search (tier, points, guest). - name: Dimensions description: Reference dimensions — booking channels and bookable spaces. - name: Properties description: >- Properties within a group, plus self-serve onboarding (org-anchored tenant bootstrap). - name: SQL description: >- Read-only SQL over the public data model, isolated per tenant by row-level security. - name: API Keys description: Manage the organization's API keys (session-only). - name: Integrations description: >- Connection metadata for source systems (Mews, Square, …). Metadata only — never canonical guest data. Session-only. paths: /v1/master-profiles/directory: get: tags: - Master Profiles summary: List master profile directory (offset pages) description: > 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`. parameters: - name: q in: query description: Free-text match on master name, email, or phone (masters only). schema: type: string - name: offset in: query description: Zero-based row offset (clamped to 50,000; deep offsets degrade). schema: type: integer minimum: 0 default: 0 - name: sort_by in: query description: Allowlisted sort column. schema: type: string enum: - updated_at - name - email - profile_count default: updated_at - name: sort_dir in: query schema: type: string enum: - asc - desc default: desc - name: include_total in: query description: > When true/1, include `total_count`. Defaults to true when offset is 0, false otherwise. schema: type: string enum: - '0' - '1' - 'true' - 'false' - $ref: '#/components/parameters/PropertyHeader' - $ref: '#/components/parameters/Limit' responses: '200': description: Directory page with optional total_count. content: application/json: schema: type: object required: - data - has_more - next_offset properties: data: type: array items: $ref: '#/components/schemas/MasterProfileDirectoryRow' has_more: type: boolean next_offset: type: - integer - 'null' description: Offset for the next page, or null when exhausted. total_count: type: integer description: Full filtered directory size (when counted). '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' components: parameters: PropertyHeader: name: X-Property-Id in: header required: false description: > 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. schema: type: string format: uuid Limit: name: limit in: query required: false description: > 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. schema: type: integer minimum: 1 maximum: 500 default: 100 schemas: MasterProfileDirectoryRow: type: object description: > Unified Master Profiles list row — either a clustered master (`kind=clustered`) or an unclustered guest singleton (`kind=singleton`). required: - id - kind - profile_count - updated_at properties: id: type: string format: uuid kind: type: string enum: - clustered - singleton first_name: type: - string - 'null' surname: type: - string - 'null' email_address: type: - string - 'null' format: email phone_number: type: - string - 'null' profile_count: type: integer updated_at: type: string format: date-time attribute_sources: type: object additionalProperties: true integration_id: type: - string - 'null' format: uuid description: Present for singleton rows (guest integration). Error: type: object required: - error properties: error: type: string description: Machine-readable error code. scope: type: string description: The scope that was required when the error is a scope failure.: null detail: type: string description: Optional human-readable detail. responses: BadRequest: description: >- Malformed request — e.g. a `cursor` that is not a valid pagination token. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: invalid_cursor Unauthorized: description: Missing, unknown, or revoked bearer credential. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: unauthorized Forbidden: description: > The credential lacks the scope required for this endpoint, or the auth surface is wrong. Machine-readable codes include `forbidden` (scope or role), `tenant_not_provisioned` (org claim present but no property group), and `mcp_oauth_required` (SPA session token used on `/mcp`). content: application/json: schema: $ref: '#/components/schemas/Error' example: error: forbidden scope: read:guests securitySchemes: bearerAuth: type: http scheme: bearer description: > `Authorization: Bearer `. 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. ````