Skip to main content

Get List of Destinations

Use this command to get details of all destinations.

Tip

  • Destinations are paged and have a numPages attribute in the response. If the numPages value is greater than 1, use the page and/or pageSize parameters to access the rest of the data. For example, GET /api/destinations?page=2&pageSize=10 fetches destinations 11-20 from the collection.

  • You may also filter the list by tags. For example: GET /api/destinations?tags=tag1,tag2

Active for Version: 4.2+

Authorizations: Administrator, Operator, Observer

Requests

CODE
GET /api/destinations
cookie: sessionID: [Session ID]

Parameters

N/A

Response

CODE
{
  "data": { [
    <Array of Destinations Objects>
  ]},
  "numPages": 1,
  "numResults": 3
}

Name

Type

Description

data

object

Data object, including destinations objects (see Destinations Object Model for definition).

numPages

number

Number of pages of destinations. See the above tip on using the numPages attribute.

numResults

number

Number of available destinations.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.