Skip to main content

DestinationsRequest

Request payload for retrieving destinations

query object

Query criteria for filtering destinations

connectionCodestring

Optional connection code for filtering

providerCodestring

Optional provider code for filtering

destinationCodesstring[]

List of destination codes to filter by

maxSizeinteger

Maximum number of results to return

tokenstring

Pagination token for the next page of results. To retrieve the next page, include this token in the 'token' field of the subsequent request. Tokens are valid for 4 minutes and are tied to the original query criteria. If the query criteria change, a new token must be generated.

DestinationsRequest
{
"query": {
"connectionCode": "string",
"providerCode": "string",
"destinationCodes": [
"string"
],
"maxSize": 0
},
"token": "string"
}