Look Up Booking by UUID

This endpoint returns a booking by its uuid, the code carried by the client's self-service
links (links.confirm, links.cancel, links.edit).

Important Notes

  • Requires bookings:read scope (it is a read, sent as POST).
  • The uuid goes in the body, not in the URL, so that it never reaches access logs, request
    logs or monitoring: it grants control of the booking. Keep it out of your own URLs and logs
    as well.
  • uuid must be a UUID (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx, hexadecimal); anything else is
    rejected before reaching the bookings service.
  • Only bookings of the company of the API key are found; any other uuid answers
    404 booking_not_found.
  • The answer is the detail of the booking, links included, as getBooking.

Errors Dictionary

StatusErrorDetailDescription
400invalid_bodyexpected_objectRequest body is not a JSON object.
400requireduuiduuid is missing or empty.
400invalid_formatuuiduuid is not a UUID.
401unauthorizedinvalid_api_keyMissing or invalid Bearer token.
401unauthorizedapi_config_inactiveAPI access is inactive for this company.
403forbiddenscope_deniedAPI key lacks bookings:read scope.
404booking_not_found—No booking of the company has that uuid.
429rate_limitedburst_limit_exceededPer-minute request limit exceeded.
429rate_limiteddaily_quota_exceededDaily request quota exceeded.
502upstream_unavailableconnection_failedThe upstream service is unavailable.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
uuid
required

The booking uuid (from its self-service links or the booking detail).

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json