List Booking History

This endpoint returns the change history of a booking, newest first.

Important Notes

  • Requires bookings:read scope.
  • Each entry carries user {id}: the AgendaPro user who made the change, or null when the change had no user (a system process, an online booking). The user's email is not exposed. employee_code identifies who acted when the company uses employee codes.
  • The history is not filtered by status: a booking has few entries, so read all of its pages and derive the status changes on your side (recipe below).

Recipe: who marked the booking as attended or no-show

Read the whole history (every page) and walk it from oldest to newest (the list comes newest first). A status transition is an entry whose status.id differs from the entry right before it in time, or the oldest entry. Who marked the booking as attended (status.id 3) or no-show (status.id 6) is the user.id of the most recent transition to that status (null when the change had no user), and its created_at is when. A later entry that keeps the status (an edit of an attended booking) is not a transition: in 1 → 3 (A) → 3 (B) A marked it, while in 1 → 3 (A) → 1 → 3 (B) B did. No transition to that status means nobody marked it. The booking's current status.id tells whether that mark still holds.

Errors Dictionary

StatusErrorDetailDescription
400(upstream)page or per_page is not a positive integer; legacy single-key code from platform-bookings.
401unauthorizedinvalid_api_keyMissing or invalid Bearer token.
401unauthorizedapi_config_inactiveAPI access is inactive for this company.
403forbiddenscope_deniedAPI key lacks bookings:read scope.
404not_foundbookingBooking not found, or it belongs to another company.
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…
Path Params
int64
required
≥ 1

Booking unique identifier.

Query Params
integer
≥ 1
Defaults to 1

Page number (defaults to 1).

integer
≥ 1
Defaults to 30

Records per page (defaults to 30).

Responses

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