Overview

Introduction Changelog Requirements Libraries Authorization Testing the Authorization Enumerables

Endpoints

Accounts Amenities Applications Availabilities Bathrooms Bedrooms Booking Discount Codes Booking Discount Code Usages Bookings Booking Comments Bookings Fees Bookings Payments Bookings Tags Bookings Taxes Change Overs Clients Contacts Destinations Fees Fees Taxes Hosts Inbox Attachments Inbox Conversations Inbox Messages Inbox Participants Inquiries Living Rooms LOS Records Me Mid Term Rate Maps Nightly Rate Maps Payment Gateways Payments Periods Photos Rates Rates Rules Rates Tables Rentals Rental Contacts Rental Agreements Rental Cancelation Policies Rental Cancelation Policy Items Rentals Amenities ! Rentals Contents Overrides Rentals Fees Rental Link Groups Rental Links Rentals Tags Rentals Taxes Rental URLs Reviews Seasons Sources Special Offers Taxes Tax Rules

Destinations

  1. Overview
  2. List destinations
  3. Get a single destination

Overview

This resource represents the Destinations (the actual place) that can be assigned to Rentals.

Parameters

Name Type Read/Write Description
id Integer Read Destination’s id.
aliases Object Read Destination’s aliases, list of locales described in enums section.
ancestor_ids Array Read Array of destination’s ancestor destinations ids.
counter Integer Read Destination’s use counter for rentals.
fullname Object Read Destination’s fullname, list of locales described in enums section.
name Object Read Destination’s name, list of locales described in enums section.
permalink Object Read Destination’s permalink, list of locales described in enums section.
created_at Time Read Destination’s create time.
updated_at Time Read Destination’s update time.

List destinations

List all destinations for a given account(s).

GET /destinations

Response

{
  "destinations": [
    {
      "id": 3212,
      "aliases": {
      },
      "ancestor_ids": [
        1
      ],
      "counter": 1,
      "fullname": {
        "en": "Europe, World"
      },
      "name": {
        "en": "Europe"
      },
      "permalink": {
        "en": "world/europe"
      }
    }
  ],
  "meta": {
  }
}

Get a single destination

Returns a single destination identified by ID.

GET /destinations/:destination_id

Response

{
  "destinations": [
    {
      "id": 3212,
      "aliases": {
      },
      "ancestor_ids": [
        1
      ],
      "counter": 1,
      "fullname": {
        "en": "Europe, World"
      },
      "name": {
        "en": "Europe"
      },
      "permalink": {
        "en": "world/europe"
      }
    }
  ],
  "meta": {
  }
}