Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.recepai.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Endpoint

GET https://app.recepai.ai/api/pms/v1/{slug}/guests
Returns all currently in-house guests that were created through the PMS API. This endpoint is useful for verification, debugging, and reconciliation before running a full sync.

​
Headers

HeaderRequiredDescription
AuthorizationYesBearer pms_live_xxx or Bearer pms_test_xxx
No request body. No Idempotency-Key required (this is a GET request).

​
Response: Success (200)

{
  "guests": [
    {
      "pmsGuestId": "RES-2026-001",
      "firstName": "John",
      "lastName": "Doe",
      "roomNumber": "301",
      "checkInDate": "2026-02-18",
      "checkOutDate": "2026-02-22",
      "phone": "+905551234567",
      "source": "pms",
      "createdAt": "2026-02-18T14:00:00Z"
    },
    {
      "pmsGuestId": "RES-2026-002",
      "firstName": "Maria",
      "lastName": "Garcia",
      "roomNumber": "405",
      "checkInDate": "2026-02-16",
      "checkOutDate": "2026-02-20",
      "phone": "+491234567890",
      "source": "pms",
      "createdAt": "2026-02-16T10:30:00Z"
    }
  ],
  "count": 2,
  "requestId": "req_q7r8s9t0"
}

​
Guest Object Fields

FieldTypeDescription
pmsGuestIdstringYour PMS’s identifier for this guest
firstNamestringGuest first name (may be null if not provided at check-in)
lastNamestringGuest last name
roomNumberstringCurrent room number
checkInDatestringCheck-in date (YYYY-MM-DD)
checkOutDatestringExpected checkout date (YYYY-MM-DD)
phonestringPhone number in E.164 format (may be null)
sourcestringAlways "pms" for guests created through this API
createdAtstringTimestamp when the guest was checked in (ISO 8601)
PMS guests only. This endpoint only returns guests with source: "pms" — guests that were created through the PMS API. Guests entered manually by hotel staff are not included. This ensures your PMS sees only the data it manages.

​
Use Cases

  • Verification: After a series of check-ins, confirm all guests were recorded correctly
  • Debugging: If a guest is missing from the hotel dashboard, check if the PMS API received the check-in
  • Pre-sync check: Before running a full sync, compare your current guest list with what RecepAI has

​
Example: cURL

curl -X GET https://app.recepai.ai/api/pms/v1/grand-hotel/guests \
  -H "Authorization: Bearer pms_live_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6"