Plans

List plan stops

get/plans/{planId}/stops

Request

Path parameters

planIdstring required

The plan id

Query parameters

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

Response

Success

nextPageTokenstring nullable required

The next page token.

Changes

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