Docs
Get an API key
Hotel bookings

List your hotel bookings

GET
/v1/hotel/bookings

You receive your booking summaries from newest to oldest, each with its payments but without their cards. You filter by status, your exact reference_id, or both; these filters apply only to bookings owned by your organization and user. A reference is not unique, so keep every matching result. Use limit and offset to request another page with the same filters, and stop when meta.has_more is false. Concurrent changes can shift offset-based pages. Read a booking by ID for its contact, room details and cards.

Authorization

x-api-key<token>

Your API key. Issued and revoked from the TrustPixel dashboard; the gateway resolves it to an owning organization on every request.

In: header

Query Parameters

limit?integer
Range1 <= value <= 100
Default25
offset?|
Range0 <= value <= 100000
Default0
status?string

You filter by one current booking status.

Value in

  • "CREATED"
  • "PREBOOK_IN_PROGRESS"
  • "READY_FOR_COMPLETE"
  • "COMPLETE_IN_PROGRESS"
  • "CONFIRMED"
  • "CANCEL_IN_PROGRESS"
  • "PARTIALLY_CANCELED"
  • "CANCELED"
  • "FAILED"
  • "EXPIRED"
reference_id?string

You match the reference_id you supplied at prebook exactly, including case. A reference can identify more than one booking.

Length1 <= length <= 200

Header Parameters

x-request-id?string

Correlation id echoed to the upstream service and returned on the response. Generated as req_<uuid> when omitted.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/hotel/bookings"
{  "data": [    {      "id": "bkg_example",      "reference_id": "order-example",      "status": "CONFIRMED",      "hotel": {        "id": "htl_example",        "name": "Example Marina Hotel",        "address": "Example Avenue, Dubai, AE"      },      "check_in": "2027-11-22",      "check_out": "2027-11-24",      "total": {        "amount": 600,        "currency": "USD"      },      "created_at": "2027-10-01T10:01:00Z",      "updated_at": "2027-10-01T10:03:00Z",      "confirmed_at": "2027-10-01T10:03:00Z",      "canceled_at": null,      "payments": [        {          "id": "pay_example",          "status": "CAPTURED",          "amount": {            "amount": 600,            "currency": "USD"          },          "created_at": "2027-10-01T10:02:00Z"        }      ]    }  ],  "meta": {    "limit": 25,    "offset": 0,    "has_more": false  }}

Read your hotel booking GET

You receive the stay, contact and guests assigned to each room. Money is in major currency units. Room prices and cancellation policies apply only to that room. Due-at-property uses a stated booking total, otherwise a complete same-currency room sum or a list when room currencies differ; null means the total is unknown. Your hotel.id is the service's stable hotel ID. You receive every payment, oldest first, with the card your traveller paid with when it could be read in time.

List your subscriptions GET

You receive your organization's subscriptions, oldest first, without their signing secrets.