Skip to main content

Driver Schedule Special Event List Ep

POST 
/v1/driver_schedule/special_event/list

List Special Events

Retrieves special events matching the given filters. Results are capped at 5000 events.
Unresolved drivers will be returned as errors while the remaining valid filters are still applied.

Required Scopes (ids.r, ids.w)

Request Body​

ids: list[str] | None = None
A list of special event IDs to retrieve.

drivers: list[Driver] | None = None
A list of driver hierarchy keys to filter by.

start_date: datetime | None = None
The earliest event start date to include.

end_date: datetime | None = None
The latest event start date to include.

timezone: TimezoneEnum = utc
The timezone to apply to the response.

types: list[str] | None = None
A list of event types to filter by. Available types can be retrieved from the /driver_schedule/special_event/types endpoint.

Response​

rows: list[SpecialEventResponse]
The matching special events.

SpecialEventResponse Fields

id: str
The internal identifier for the special event.

start_date: datetime
The start date of the event.

end_date: datetime
The end date of the event.

timezone: TimezoneEnum = utc
The timezone of the response.

type: str | None = None
The event type.

driver_id: str | None = None
The internal identifier for the driver.

driver_name: str | None = None
The name of the driver.

driver_source_system: str | None = None
The source system of the driver.

driver_source_id: str | None = None
The source system identifier for the driver.

errors: list[str]
Errors for any drivers that could not be resolved.

Responses​

Successful Response

{
  "rows": [
    {
      "id": "string",
      "start_date": "2026-05-11T19:25:52.551Z",
      "end_date": "2026-05-11T19:25:52.551Z",
      "timezone": "UTC",
      "type": "string",
      "driver_id": "string",
      "driver_name": "string",
      "driver_source_system": "string",
      "driver_source_id": "string"
    }
  ],
  "errors": [
    "string"
  ]
}
Loading...