Routes

Get Routes Page

Page through the routes in your depot, most recently updated first. Each entry is a route summary: name, plan_id, date, the dispatched and is_locked flags, stop count, planned and actual times and distances, and timestamps. The stops themselves are not included; call GET /routes/{id} for stops, orders and proof of delivery.

The list covers every route in your depot across all plans, not only each plan's current routes. A route left behind when a plan was optimised again can still appear. To see the routes currently on a plan, use GET /plans/{id}. Deleted routes drop out of the list, and the routes.deleted webhook tells you about deleted dispatched routes.

Results are paged with the Link header and limit (1–100, default 100). See Paging. Keep following the rel=next URL until a response has none. updated_at_min returns only routes whose updated timestamp is at or after the given time, and the rel=next URL carries it forward. A malformed page_info is rejected with 400 INVALID_INPUT. An updated_at_min in an unrecognised format, or a limit outside 1–100, is ignored rather than rejected.

get/routes

Request

  • Base URL: https://api.smartroutes.io/v2
  • URL: https://api.smartroutes.io/v2/routes
  • Auth: none declared

Query parameters

page_infostring

Information about the page for pagination. Generated by the OpenAPI

updated_at_minstring date-time

Minimum updated date and time for filtering.

limitinteger

Maximum number of routes to retrieve per page.

Response

Successful response

Changes

No recorded changes to this operation across all 1 revision of this API.