Sign in
route-groups

Get Route Groups

Changed on

Retrieve all route groups, optionally filtered by date range, weekday, delivery type, route status, and driver assignment status. Can include associated routes in the response.

get/api/route-groups

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Query parameters

start_datestring date nullable

Filter route groups from this date

end_datestring date nullable

Filter route groups until this date

weekdayDriveDaysOfWeekEnum[] nullable

Filter by one or more weekdays

delivery_typestring[] nullable

Filter by one or more delivery types

route_statusRouteStatusEnum[] nullable

Filter by one or more route statuses

driver_assignment_statusDriverAssignmentStatusEnum[] nullable

Filter by one or more driver assignment statuses

include_routesboolean

Include routes in the response

searchstring nullable

Case-insensitive filter on the route group name

pageinteger

Page number (1-indexed)

page_sizeinteger

Number of items per page

Response

Successful Response

pageinteger required
page_sizeinteger required
totalinteger required
total_pagesinteger required

Changes