List Destinations
You can List all of the Destinations currently set up on your account by making making a HTTP GET request to the /destinations endpoint.
The following querystring (HTTP GET) parameters allow you to refine the results returned by the Destinations List API.
Parameter | Required | Description |
---|---|---|
api_key | required | The API key for your account. |
search_term | optional | Limits the returned Destinations to just those containing the search_term in their name. |
page | optional | Set the page number of Destinations to return, defaults to page=1 . 10 Destinations are returned per page. |
sort_by | optional | The sort order to apply to the results. Valid values are type (to sort by Destination type) or name (to sort by Destination name). |
sort_direction | optional | The sort direction to return results. Valid values are descending or ascending (the default). Use in conjunction with the sort_by parameter. |
GET /destinations
In the example below we List page 1 of all the Destinations on your account:
Scale SERP responds with the following JSON showing page 1 of all the Destinations on your Scale SERP account:
Next Steps Update Destination Delete Destination