Get All Scheduled Trips

{
  "limit": 2,
  "offset": 10,
  "countries": ["KE"],
  "max_price": 1500,
  "min_price": 1000, 
  "required_guides": ["SAFARI"], 
  "destinations": [3], 
  "properties": [1, 2], 
  "suppliers": [1], 
  "date": "2024-10-05T14:48:00.000Z", 
  "days": 7, 
  "number_of_travellers": 2,
  "featured": false, 
  "traveller_preferences": ["Wildlife"],
  "traveller_type": ["Couples"]
}

{ 
    "total_length": 25,
    "filtered_length": 1, 
    "trips": [
        {
            "id": 11,
            "name": "5 Day Tanzanian Safari, Savannah Tours",
            "scheduled_dates": ["2024-11-05T14:48:00.000Z", "2024-10-12T14:48:00.000Z"]
            "trip_overview": "A comprehensive 5-day safari experience starting from Arusha to Tarangire National Park with game drives and accommodations at Burunge Tented Lodge, among other destinations.",
            "pricing": {
                "price": 1200,
                "currency": "USD"
            },
            "included": ["4x4 Private safari vehicle", "Professional guide", "Park Fees", "Accommodations"],
            "excluded": ["Driver / guide tips", "Airport transfers", "Anything not explicitly included"],
            "minimum_travellers": 2,
            "suppliers": [
            {
                "name": "Savannah Tours",
                "logo_url": "https://example.com/logo_url.jpg"
            }
            ],
            "image_urls": [
                "https://cloudsafaris.com/path/to/image1.jpg",
                "https://cloudsafaris.com/path/to/image2.jpg"
            ],
            "file_urls": [],
            "trip_extras": [
            {
                "id": 1,
                "name": "4x4 Safari Cruiser",
                "description": "Included as part of the package",
                "optional": false,
                "per_unit": false,
                "multiple_units": false,
                "max_travellers": 0
            },
            {
                "id": 2,
                "name": "Airport Transfer in a 4x4 Safari Cruiser",
                "description": "Optional transfer from JRO to Arusha",
                "optional": true,
                "per_unit": true,
                "multiple_units": false,
                "max_travellers": 4
            },
            {
                "id": 3,
                "name": "Accommodation Extension at Mount Meru Game Lodge",
                "description": "Optional extra nights available in different board bases",
                "optional": true,
                "per_unit": true,
                "multiple_units": true,
                "max_travellers": 0
            }
            ],
            "days": [
            {
                "id": 1,
                "title": "Arusha to Tarangire National Park",
                "description": "Depart from Arusha and drive to Tarangire National Park for a full day of game drives.",
                "extra_details": "",
                "meals": ["Lunch", "Dinner"],
                "properties": [12],
                "destinations": [20],
                "activities": [],
                "day_extras": [],
                "transfers": [
                    {
                        "initial_id": 0,
                        "final_id": 20,
                        "transfer_type": "Vehicle", 
                        "moment": "MORNING"
                    }
                ]
            }
            // Additional days follow a similar structure
            ],
            "countries": ["TZ"], 
            "pick_up_location": {
                latitude: -3.429406, 
                longitude: 37.074461, 
                note: "Kilimanjaro International Airport",
                radius: 50,
                location_max_time: "08:00:00",         
            }, 
            "drop_off_location": {
                latitude: -3.429406, 
                longitude: 37.074461, 
                note: "Kilimanjaro International Airport",
                radius: 50,
                location_max_time: "08:00:00",         
            }, 
            "trip_category": "",
            "route": [],
            "promos": [], 
            "short_description": "A comprehensive 5-day safari experience starting from Arusha to Tarangire National Park",
            "why_this_trip": "",
            "traveller_type": ["Friends", "Family", "Couples"],
            "traveller_preferences": ["Wildlife", "Culture", "Photography", "Relaxation", "Active"],
            "popularity_tag": "Best Seller"
        }
    ]
}

POST

trips

get-all-scheduled-trips

{
  "limit": 2,
  "offset": 10,
  "countries": ["KE"],
  "max_price": 1500,
  "min_price": 1000, 
  "required_guides": ["SAFARI"], 
  "destinations": [3], 
  "properties": [1, 2], 
  "suppliers": [1], 
  "date": "2024-10-05T14:48:00.000Z", 
  "days": 7, 
  "number_of_travellers": 2,
  "featured": false, 
  "traveller_preferences": ["Wildlife"],
  "traveller_type": ["Couples"]
}

{ 
    "total_length": 25,
    "filtered_length": 1, 
    "trips": [
        {
            "id": 11,
            "name": "5 Day Tanzanian Safari, Savannah Tours",
            "scheduled_dates": ["2024-11-05T14:48:00.000Z", "2024-10-12T14:48:00.000Z"]
            "trip_overview": "A comprehensive 5-day safari experience starting from Arusha to Tarangire National Park with game drives and accommodations at Burunge Tented Lodge, among other destinations.",
            "pricing": {
                "price": 1200,
                "currency": "USD"
            },
            "included": ["4x4 Private safari vehicle", "Professional guide", "Park Fees", "Accommodations"],
            "excluded": ["Driver / guide tips", "Airport transfers", "Anything not explicitly included"],
            "minimum_travellers": 2,
            "suppliers": [
            {
                "name": "Savannah Tours",
                "logo_url": "https://example.com/logo_url.jpg"
            }
            ],
            "image_urls": [
                "https://cloudsafaris.com/path/to/image1.jpg",
                "https://cloudsafaris.com/path/to/image2.jpg"
            ],
            "file_urls": [],
            "trip_extras": [
            {
                "id": 1,
                "name": "4x4 Safari Cruiser",
                "description": "Included as part of the package",
                "optional": false,
                "per_unit": false,
                "multiple_units": false,
                "max_travellers": 0
            },
            {
                "id": 2,
                "name": "Airport Transfer in a 4x4 Safari Cruiser",
                "description": "Optional transfer from JRO to Arusha",
                "optional": true,
                "per_unit": true,
                "multiple_units": false,
                "max_travellers": 4
            },
            {
                "id": 3,
                "name": "Accommodation Extension at Mount Meru Game Lodge",
                "description": "Optional extra nights available in different board bases",
                "optional": true,
                "per_unit": true,
                "multiple_units": true,
                "max_travellers": 0
            }
            ],
            "days": [
            {
                "id": 1,
                "title": "Arusha to Tarangire National Park",
                "description": "Depart from Arusha and drive to Tarangire National Park for a full day of game drives.",
                "extra_details": "",
                "meals": ["Lunch", "Dinner"],
                "properties": [12],
                "destinations": [20],
                "activities": [],
                "day_extras": [],
                "transfers": [
                    {
                        "initial_id": 0,
                        "final_id": 20,
                        "transfer_type": "Vehicle", 
                        "moment": "MORNING"
                    }
                ]
            }
            // Additional days follow a similar structure
            ],
            "countries": ["TZ"], 
            "pick_up_location": {
                latitude: -3.429406, 
                longitude: 37.074461, 
                note: "Kilimanjaro International Airport",
                radius: 50,
                location_max_time: "08:00:00",         
            }, 
            "drop_off_location": {
                latitude: -3.429406, 
                longitude: 37.074461, 
                note: "Kilimanjaro International Airport",
                radius: 50,
                location_max_time: "08:00:00",         
            }, 
            "trip_category": "",
            "route": [],
            "promos": [], 
            "short_description": "A comprehensive 5-day safari experience starting from Arusha to Tarangire National Park",
            "why_this_trip": "",
            "traveller_type": ["Friends", "Family", "Couples"],
            "traveller_preferences": ["Wildlife", "Culture", "Photography", "Relaxation", "Active"],
            "popularity_tag": "Best Seller"
        }
    ]
}

Header Parameters

CloudSafaris-API-Version

string

default:"v1"

Currently the only acceptable value is v1.

Request Body Parameters

limit

number

The limit on the number of trips to return.

offset

number

default:0

If requesting another set of trips, this will apply the offset to the next set of trips.

countries

string[]

default:[]

An array of string values of either TZ or KE, or both.

max_price

number

default:10000

The maximum price of the trips that are returned within a given calendar year. The prices are per person, and based on 2 travellers. For example if you set this as 3000 only packages that have a max price under 3000 will be returned.

min_price

number

default:0

The minimum price of the trips that are returned within a given calendar year. The prices are per person, and based on 2 travellers. For example if you set this as 3000 only packages that have a min price over 3000 will be returned.

required_guides

string[]

default:[]

An array of string values of either SAFARI or KILIMANJARO, or both. This will return trips that are associated with the required guide tags that are passed. For example, passing in ["KILIMANJARO"] will only return trips that require a guide for Kilimanjaro.

destinations

number[]

default:[]

The ids of the destinations. If supplied this will only return trips that contain at least one of the given destination ids.

properties

number[]

default:[]

The ids of the properties. If supplied this will only return trips that contain at least one of the given properties.

suppliers

number[]

default:[]

The ids of the desired suppliers. THis will return only trips provided by the chosen suppliers.

date

string

required

The desired start date (isoString) of the trip.

days

number

The desired maximum length of the trip

number_of_travellers

number

default:2

The number of travellers on the trip

featured

boolean

Return only featured trips. Featured trips are designated by CloudSafaris based on popularity, trending, or promoted.

traveller_preferences

enum[]

The travellers travel style preferences. The available options are: [“Wildlife”, “Culture”, “Photography”, “Relaxation”, “Active”, “Mountain Climbing”, “Beach”]

traveller_type

enum[]

Descriptor for the type of traveller(s) on the of trip: [“Friends”, “Family”, “Couples”, “Solo”]

{
  "limit": 2,
  "offset": 10,
  "countries": ["KE"],
  "max_price": 1500,
  "min_price": 1000, 
  "required_guides": ["SAFARI"], 
  "destinations": [3], 
  "properties": [1, 2], 
  "suppliers": [1], 
  "date": "2024-10-05T14:48:00.000Z", 
  "days": 7, 
  "number_of_travellers": 2,
  "featured": false, 
  "traveller_preferences": ["Wildlife"],
  "traveller_type": ["Couples"]
}

Response Body Parameters

total_length

number

The total number of trips in our database

filtered_length

number

The number of trips returned after any filters or length limits are applied

trips

Trip Object Array

Hide child attributes

number

The trip id is the unique id of the trip returned.

scheduled_dates

string[]

Scheduled dates of departure for this trip. This field is nullable

name

string

The name of the the trip.

trip_overview

string

The overview of the trip (overall description).

pricing

object

Hide child attributes

price

number

Price for the trip.

currency

string

The currency for the low and high values. I.e. USD.

included

string[]

What’s included on the trip.

excluded

string[]

What’s excluded from the trip.

minimum_travellers

number

The minimum number of travellers required to book the trip.

suppliers

object[]

Hide child attributes

name

string

The name of the supplier (local tour company) to fulfill the trip.

logo_url

string

The URL for the logo of the supplier (local tour company).

image_url

string[]

The URLs of the images that can be used for this trip.

file_urls

string[]

The URLs for any files associated with this trip.

trip_extras

object[]

Hide child attributes

number

The id of the extra.

name

string

The name of the extra.

description

string

The description for the extra.

optional

boolean

Whether the extra is optional or included by default in the trip.

per_unit

boolean

Whether the extra is per unit, or if pricing is different based on the traveller.

multiple_units

boolean

Whether the traveller is allowed to add multiple units.

max_travellers

number

The maximum number of travellers that this extra will apply to. For example, a vehicle could have a maximum capacity of 4 travellers.

days

object[]

Hide child attributes

number

The id corresponding to the day of the trip.

title

string

The title corresponding to the day.

description

string

The description for the day.

extra_details

string

Any extra details that are specified for the day.

meals

string[]

The meals and drinks that are included for the day.

properties

number[]

The property ids that are associated with the day.

destinations

number[]

The destination ids that are associated with the day.

activities

object[]

Hide child attributes

number

optional

boolean

Whether the activity is optional for the user or included by default.

day_extras

object[]

Hide child attributes

number

name

string

description

string

optional

boolean

Flag identifying the extra is optional or included by default.

per_unit

number

Whether this is a per unit cost or if the cost will apply based on the travellers.

multiple_units

boolean

Whether the traveller is able to select for multiple units or not.

max_travellers

number

The maximum travellers for the given extra. For example, a vehicle may only take a maximum of 4 travellers.

transfers

object[]

Hide child attributes

initial_id

number

The destination id of the initial destination. If 0 is returned back then this can either be an accommodation from the day before, or a general pick-up location.

final_id

number

The destination id of the final destination for the transfeer. If 0 is returned back then this can either be an accommodation for the night or a general drop-off location.

transfer_type

string

The type of transfer between the initial and final destination. Possible values are below: Vehicle, Flight, Hike, Walk, Boat, Trek

countries

string[]

An array of country enums where this trip takes place

pick_up_location

object[]

Hide child attributes

latitude

number

The latitude of the pickup location

longitude

number

The longitude of the pickup location

note

string

A note about the pickup, providing more detail about the location

radius

number

The radius outlining the bounds of possible area for pickup

location_max_time

string

The latest a traveller could be picked up from this location

drop_off_location

object[]

Hide child attributes

latitude

number

The latitude of the drop-off location

longitude

number

The longitude of the drop-off location

note

string

A note about the drop-off, providing more detail about the location

radius

number

The radius outlining the bounds of possible area for drop-off

location_max_time

string

The latest a traveller could be dropped-off at this location

trip_category

string

Category of the trip as defined by the supplier.

route

object[]

Hide child attributes

destination_id

number

destination_name

string

destination_type

string

latitude

number

longitude

number

promos

object[]

Hide child attributes

Code

string

FixedDiscount

number

If the discount is a fixed amount (i.e. $100 off) as defined by the ApplyPercentage flag, it will be set here.

PercentageDiscount

number

If the discount is a fixed amount (i.e. 10% off) as defined by the ApplyPercentage flag, it will be set here.

ApplyPercentage

boolean

Flag defining whether to apply fixed or percentage discount.

AtCost

boolean

Flag for promotions selling packages at cost.

Expiry

string

Date isoString defining the expiration date of the promotion.

short_description

string

A short description for the trip.

why_this_trip

string

A call to action for this trip.

traveller_type

string[]

Descriptor for the type of traveller(s) on the of trip: [“Friends”, “Family”, “Couples”, “Solo”]

traveller_preferences

string[]

The travellers travel style preferences. The available options are: [“Wildlife”, “Culture”, “Photography”, “Relaxation”, “Active”, “Mountain Climbing”, “Beach”]

popularity_tag

string

The available options are: [“Best Seller”, “Fan Favourite”, “Top Rated”, “Most Popular”, “Highly Recommended”, “Trending Now”, “Must-see”, “Editor’s Choice”, “Hot Deal”, “Ultimate Experience”, “Exclusive Offer”]

{ 
    "total_length": 25,
    "filtered_length": 1, 
    "trips": [
        {
            "id": 11,
            "name": "5 Day Tanzanian Safari, Savannah Tours",
            "scheduled_dates": ["2024-11-05T14:48:00.000Z", "2024-10-12T14:48:00.000Z"]
            "trip_overview": "A comprehensive 5-day safari experience starting from Arusha to Tarangire National Park with game drives and accommodations at Burunge Tented Lodge, among other destinations.",
            "pricing": {
                "price": 1200,
                "currency": "USD"
            },
            "included": ["4x4 Private safari vehicle", "Professional guide", "Park Fees", "Accommodations"],
            "excluded": ["Driver / guide tips", "Airport transfers", "Anything not explicitly included"],
            "minimum_travellers": 2,
            "suppliers": [
            {
                "name": "Savannah Tours",
                "logo_url": "https://example.com/logo_url.jpg"
            }
            ],
            "image_urls": [
                "https://cloudsafaris.com/path/to/image1.jpg",
                "https://cloudsafaris.com/path/to/image2.jpg"
            ],
            "file_urls": [],
            "trip_extras": [
            {
                "id": 1,
                "name": "4x4 Safari Cruiser",
                "description": "Included as part of the package",
                "optional": false,
                "per_unit": false,
                "multiple_units": false,
                "max_travellers": 0
            },
            {
                "id": 2,
                "name": "Airport Transfer in a 4x4 Safari Cruiser",
                "description": "Optional transfer from JRO to Arusha",
                "optional": true,
                "per_unit": true,
                "multiple_units": false,
                "max_travellers": 4
            },
            {
                "id": 3,
                "name": "Accommodation Extension at Mount Meru Game Lodge",
                "description": "Optional extra nights available in different board bases",
                "optional": true,
                "per_unit": true,
                "multiple_units": true,
                "max_travellers": 0
            }
            ],
            "days": [
            {
                "id": 1,
                "title": "Arusha to Tarangire National Park",
                "description": "Depart from Arusha and drive to Tarangire National Park for a full day of game drives.",
                "extra_details": "",
                "meals": ["Lunch", "Dinner"],
                "properties": [12],
                "destinations": [20],
                "activities": [],
                "day_extras": [],
                "transfers": [
                    {
                        "initial_id": 0,
                        "final_id": 20,
                        "transfer_type": "Vehicle", 
                        "moment": "MORNING"
                    }
                ]
            }
            // Additional days follow a similar structure
            ],
            "countries": ["TZ"], 
            "pick_up_location": {
                latitude: -3.429406, 
                longitude: 37.074461, 
                note: "Kilimanjaro International Airport",
                radius: 50,
                location_max_time: "08:00:00",         
            }, 
            "drop_off_location": {
                latitude: -3.429406, 
                longitude: 37.074461, 
                note: "Kilimanjaro International Airport",
                radius: 50,
                location_max_time: "08:00:00",         
            }, 
            "trip_category": "",
            "route": [],
            "promos": [], 
            "short_description": "A comprehensive 5-day safari experience starting from Arusha to Tarangire National Park",
            "why_this_trip": "",
            "traveller_type": ["Friends", "Family", "Couples"],
            "traveller_preferences": ["Wildlife", "Culture", "Photography", "Relaxation", "Active"],
            "popularity_tag": "Best Seller"
        }
    ]
}

Get All Trips Get All Short Trips

⌘I

Get Started

Trips

Destinations

Properties

Pricing

Quotes

Payments

Header Parameters

Request Body Parameters

Response Body Parameters

Get Started

Trips

Destinations

Properties

Pricing

Quotes

Payments

​Header Parameters

​Request Body Parameters

​Response Body Parameters

Header Parameters

Request Body Parameters

Response Body Parameters