Routes

List route stops

get/routes/{routeId}/stops

Request

Base URL
https://api.spoke.com/public/v1
Auth
HTTP basic
TypeScript
https://skmtc.dev/spoke/apis/spoke-api/docs/routes/:routeId/stops/get.ts
A function with typed inputs. Its response is checked against the schema.

routeIdstring required

The route id

pageTokenstring

The page token, if any.

maxPageSizenumber

The max page size.

externalIdstring

Filter by the recipient.externalId field, exact match

The filter to apply to the list of stops. The filter params are passed like this: ?filter[externalId]=foo or like this: ?filter.externalId=foo

Success

nextPageTokenstring nullable required

The next page token.

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