Skip to main content

Customers

The guest directory. Bookings carry their own inline guest details (so deleting a customer never loses stay history); linking a booking to a customer record is optional and useful for repeat-guest tooling.

Endpoints​

MethodPathDescription
GET/v1/customersList (filters: email, phone)
POST/v1/customersCreate
GET/v1/customers/{id}Retrieve
PATCH/v1/customers/{id}Update
DELETE/v1/customers/{id}Delete

Create​

curl -s $API/v1/customers -H "Authorization: Bearer $KEY" \
-H "Idempotency-Key: cust-rider" -H "Content-Type: application/json" \
-d '{"first_name":"Alex","last_name":"Rider","email":"alex@example.com",
"phone":"+441234567890"}'

phone is required (it is the field the portal's customer records rely on). Link a booking by passing customer when creating a booking, and expand it with GET /v1/bookings/{id}?expand[]=customer.