post
https://connect.agendapro.com/v3/bookings/lookup
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:readscope (it is a read, sent asPOST). - The
uuidgoes 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. uuidmust 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
uuidanswers
404 booking_not_found. - The answer is the detail of the booking,
linksincluded, asgetBooking.
Errors Dictionary
| Status | Error | Detail | Description |
|---|---|---|---|
| 400 | invalid_body | expected_object | Request body is not a JSON object. |
| 400 | required | uuid | uuid is missing or empty. |
| 400 | invalid_format | uuid | uuid is not a UUID. |
| 401 | unauthorized | invalid_api_key | Missing or invalid Bearer token. |
| 401 | unauthorized | api_config_inactive | API access is inactive for this company. |
| 403 | forbidden | scope_denied | API key lacks bookings:read scope. |
| 404 | booking_not_found | — | No booking of the company has that uuid. |
| 429 | rate_limited | burst_limit_exceeded | Per-minute request limit exceeded. |
| 429 | rate_limited | daily_quota_exceeded | Daily request quota exceeded. |
| 502 | upstream_unavailable | connection_failed | The upstream service is unavailable. |
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
