Samsara Routes API is one of 90 APIs that Samsara publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Routes. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a GitHub repository.
This API exposes
7 operations
across 4 paths,
and defines 87 schemas.
It is described by OpenAPI 3.0.1, at version 2024-11-18.
Requests are made against 2 base URLs: https://api.samsara.com/, https://api.eu.samsara.com/.
The identity and technical contract details declared by the specification.
V1ErrorResponse
string
Error message describing why the request failed.
baseRouteResponseObjectResponseBody
object
13 properties
1 required
RoutesGetRoutesFeedInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
RoutesDeleteRouteUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
RoutesGetRoutesFeedTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
RoutesGetRoutesFeedBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
RoutesPatchRouteResponseBody
object
1 property
RoutesDeleteRouteBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
RoutesGetRoutesFeedNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
RoutesCreateRouteBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
MinimalRouteAuditLogsResponseBody
object
A single route. Only the fields that have changed are present in the response. All other fields, including the route id, will not be present in the response. F…
1 property
RoutesCreateRouteMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
GoaVehicleTinyResponseResponseBody
object
A minified vehicle object. This object is only returned if the route is assigned to the vehicle.
3 properties
RoutesCreateRouteRequestBody
object
7 properties
2 required
RoutesFetchRouteResponseBody
object
1 property
RoutesDeleteRouteServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
RoutesCreateRouteUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
RoutesFetchRouteTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
RouteFeedObjectResponseBody
object
Route feed object.
6 properties
5 required
RoutesDeleteRouteBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
GoaDriverTinyResponseResponseBody
object
A minified driver object. This object is only returned if the route is assigned to the driver.
3 properties
1 required
RoutesFetchRouteServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
RoutesPatchRouteBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
RoutesFetchRoutesServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
MinimalRouteStopAuditLogsResponseBody
object
A single route stop for a route.
11 properties
1 required
RoutesCreateRouteInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
RoutesDeleteRouteNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
RoutesFetchRouteUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
RouteChangesResponseBody
object
A diff of the changes for a route update.
2 properties
2 required
GoaPaginationResponseResponseBody
object
Pagination parameters.
2 properties
2 required
RoutesPatchRouteBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
RoutesFetchRouteBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
RoutesStopResponseObjectResponseBody
object
19 properties
3 required
GoaAddressTinyResponseResponseBody
object
A minified Address object
3 properties
2 required
RoutesPatchRouteTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
RoutesGetRoutesFeedMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
RoutesFetchRoutesUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
RoutesDeleteRouteNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
RoutesFetchRouteBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
RoutesPatchRouteNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
RoutesFetchRoutesBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
RoutesFetchRoutesResponseBody
object
2 properties
2 required
RoutesGetRoutesFeedResponseBody
object
2 properties
2 required
RoutesFetchRouteNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
RoutesCreateRouteServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
RoutesFetchRoutesNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
RoutesFetchRoutesMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
UpdateRoutesStopRequestObjectRequestBody
object
10 properties
RoutesGetRoutesFeedNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
RoutesPatchRouteServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
inline_object
object
1 property
RoutesGetRoutesFeedUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
GoaDocumentTinyResponseResponseBody
object
A minified Document object
2 properties
1 required
RoutesDeleteRouteMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
RoutesFetchRouteMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
RoutesFetchRouteGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
RoutesPatchRouteRequestBody
object
7 properties
RoutesFetchRoutesNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
RoutesCreateRouteTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
RoutesGetRoutesFeedBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
CreateRoutesStopRequestObjectRequestBody
object
9 properties
RoutesSingleUseAddressObjectResponseBody
object
This field is used to indicate stops along the route for which an address has not been persisted. This field is mutually exclusive with addressId.
3 properties
2 required
RoutesSingleUseAddressObjectRequestBody
object
This field is used to indicate stops along the route for which an address has not been persisted. This field is mutually exclusive with addressId.
3 properties
2 required
RoutesFetchRoutesBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
RoutesPatchRouteGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
RoutesCreateRouteGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
RoutesGetRoutesFeedServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
RoutesFetchRouteInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
RoutesFetchRoutesGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
RoutesCreateRouteBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
RoutesCreateRouteResponseBody
object
1 property
RoutesDeleteRouteTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
RouteSettingsResponseBody
object
An optional dictionary, only necessary to override the defaults for route start and end conditions.
2 properties
RoutesDeleteRouteInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
RoutesFetchRoutesTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
RoutesDeleteRouteGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
RoutesCreateRouteNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
LiveSharingLinkResponseObjectResponseBody
object
Live Sharing Link response object.
3 properties
2 required
RoutesPatchRouteUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
RoutesPatchRouteMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
RoutesCreateRouteNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
RoutesPatchRouteNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
RoutesGetRoutesFeedGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
RoutesFetchRoutesInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
RouteSettingsRequestBody
object
An optional dictionary, only necessary to override the defaults for route start and end conditions.
2 properties
RoutesPatchRouteInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
RoutesFetchRouteNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Samsara publishes across the network.
