---
title: "Gets Booking Events for a Booking leg."
method: GET
path: "/v1/bookings/{bookingReference}/events"
tags: ["Booking Events"]
---

# Gets Booking Events for a Booking leg.

`GET /v1/bookings/{bookingReference}/events`

## Request

- Base URL: `https://your.domain.com`
- URL: `https://your.domain.com/v1/bookings/{bookingReference}/events`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/suntransfers/apis/st-spec-suntransfers-supplier-api-specification/docs/v1/bookings/:bookingReference/events/get.ts> (a function with typed inputs; its response is checked against the schema)

Requests to this endpoint that fail may be retried after a few minutes. See more in the Responses section.

## Path parameters

- `bookingReference` string, required

## Query parameters

- `leg` integer, required
- `sort` 'Asc' | 'Desc', required: The direction to sort results, either ascending or descending.
- `startingAt` string, date-time: An ISO 8601 date-time string in local time.
- `endingAt` string, date-time: An ISO 8601 date-time string in local time.

## Response `200`

`200 OK`: Booking found. This Booking's events - if any - are listed in the response.

- GetBookingEventResponse: Represents the result of a request to get the Events of a Booking.
  - `bookingReference` string, required: The Suntransfers Booking reference identifier. This is currently a string starting with 'SUNTR_' followed by alphanumeric characters.
  - `leg` integer, required: The leg number of the Transfer within the Booking. Leg numbers start at 1.
  - `items` BookingEvent[], required: The list of events that happened in association with the Booking.
    - `eventType` 'DriverDepartedToPickup' | 'DriverArrivedAtPickup' | 'DriverSubmittedCustomerNoShow' | 'DriverDepartedToDropoff' | 'DriverArrivedAtDropoff' | 'DriverLiveLocation', required: The type of Booking Event.
    - `occurredAt` string, date-time, required: An ISO 8601 date-time string in local time.
    - `latitude` number, double, nullable: The Latitude coordinate of the Booking Event. Note that both `latitude` and `longitude` must be provided when `eventType` is `DriverLiveLocation`.
    - `longitude` number, double, nullable: The Longitude coordinate of the Booking Event. Note that both `latitude` and `longitude` must be provided when `eventType` is `DriverLiveLocation`.

## Other responses

- `400`: `400 Bad Request`: The details of the issues found on the request are present in the `detail` property of the response.
- `401`: `401 Unauthorized`: Credentials are likely out of sync. Contact Suntransfers as soon as possible via our official email to synchronize credentials. Attention: DO NOT specify any details about username, password, or authentication method in the response.
- `404`: `404 Not Found`: The Booking was not found.
- `500`: `500 Internal Server Error`: Suntransfers systems might retry this request later.
- `501`: `501 Not Implemented`: This operation is not supported by the API.

---

[API](https://skmtc.dev/suntransfers/apis/st-spec-suntransfers-supplier-api-specification.md) - [All operations](https://skmtc.dev/suntransfers/apis/st-spec-suntransfers-supplier-api-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/suntransfers/apis/st-spec-suntransfers-supplier-api-specification/revisions/ba6e6a567dd2?raw)