Skip to content

References

Retrieve Incidents

The GET incidents endpoint enables you to retrieve incident data.

GET /v1/incidents

Note

Incidents are returned in descending order by the last updated date time.

Request

URL Parameters

Parameter Type Default Value Description Required
lastUpdatedFrom DateTime 14 days before the current date time Incident last updated date time in UTC (ISO 8601) for start of the date range (inclusive). Yes - but only when lastUpdatedTo is provided
lastUpdatedTo DateTime The current date time Incident last updated date time in UTC (ISO 8601) for end of date range (inclusive). Yes - but only when lastUpdatedFrom is provided
pageNumber Integer 0 Page number to retrieve (zero-indexed). No
pageSize Integer 200 Number of incidents to return per page. Must be between 1 and 500. No

Warning

The maximum date range between lastUpdatedFrom and lastUpdatedTo is 365 days. Requests exceeding this range will return a 400 error.

Sample Request

GET /v1/incidents

GET /v1/incidents?lastUpdatedFrom=2024-05-01T00:00:00&lastUpdatedTo=2024-05-31T23:59:59&pageNumber=1&pageSize=500

Response

Field Type Description
incidents Object Array An array of incident objects.
incident.bookingReference String The booking reference.
incident.incidentType String One of the following values:

DRIVER_LATENESS
DRIVER_NO_SHOW
CUSTOMER_NO_SHOW
SERVICE_PROVIDED
RIDEWAYS_SERVICE
WRONG_VEHICLE
DRIVER_SERVICE
SUPPLIER_SERVICE
DRIVER_DELAY_20_TO_40_MINS
DRIVER_DELAY_UNDER_20_MINS
DRIVER_DELAY_OVER_40_MINS
INVESTIGATING_POST_JOURNEY_FEEDBACK
OTHER
incident.incidentStatus String DISPUTED — incident created, being investigated by Booking.com
RESOLVED — incident marked as resolved
incident.responsibleParty String The party responsible for the incident:

CUSTOMER
NO_ONE
BOOKING.COM
SUPPLIER
incident.createdDateTimeUTC DateTime The timestamp when the incident was first created in UTC (ISO 8601).
incident.modifiedDateTimeUTC DateTime The timestamp when the incident was last modified in UTC (ISO 8601).
incident.pickupDateTimeUTC DateTime The booking's pickup timestamp in UTC (ISO 8601).
pageSize Integer The current page size.
currentPage Integer The current page number (zero-indexed).
hasNextPage Boolean true if there are more incidents to retrieve.
nextHref String A link to retrieve the next page of incidents. Use this URL directly for pagination.

HTTP 200 - OK

{
  "incidents": [
    {
      "bookingReference": "11523901",
      "incidentType": "DRIVER_NO_SHOW",
      "incidentStatus": "RESOLVED",
      "responsibleParty": "BOOKING.COM",
      "createdDateTimeUTC": "2024-08-05T14:18:50",
      "modifiedDateTimeUTC": "2024-08-05T14:18:50",
      "pickupDateTimeUTC": "2024-08-05T13:18:50"
    },
    {
      "bookingReference": "27191328",
      "incidentType": "CUSTOMER_NO_SHOW",
      "incidentStatus": "RESOLVED",
      "responsibleParty": "CUSTOMER",
      "createdDateTimeUTC": "2024-08-05T14:18:50",
      "modifiedDateTimeUTC": "2024-08-05T13:18:50",
      "pickupDateTimeUTC": "2024-08-05T10:18:50"
    }
  ],
  "pageSize": 200,
  "currentPage": 0,
  "hasNextPage": true,
  "nextHref": "/v1/incidents?lastUpdatedFrom=2024-07-22T15:18:50&lastUpdatedTo=2024-08-05T15:18:50&pageNumber=1&pageSize=200"
}

HTTP 400 - Bad Request

{
  "errorCode": "e152c59d-5327-433c-980b-12f759b6782e",
  "errorMessage": "Min.pageNumber: must be greater than or equal to 0"
}

HTTP 401 - Unauthorized

Further reading