Skip to main content

A type that contains information about the destination search response.

Types that use DestinationSearchResponse

Not used by any types.

Call that uses DestinationSearchResponse

GET
/destination

Fields

Field
Type
Description
total
integer
The total number of matches for the search criteria.
href
string
The path to the call URI that produced the current page of results.
next
string
The URL to access the next set of results. This field includes a continuation_token. No prev field is returned, but this value is persistent during the session so that you can use it to return to the next page.

This field is not returned if fewer records than specified by the limit field are returned.
limit
integer
The number of records to show in the current response.

Default: 20
destinations
array of Destination
An array that contains the destination details.