RoundPlanAPI reference
v1OpenAPI 3.1 ↗Get an API key

Trips

Retrieve a trip's itinerary

GET/api/v1/trips/{id}/itineraryScope trips:read

The trip day by day as its client sees it, with the package price: the same days, items, texts, hotels and extras as their trip page. Never internal costs, margins, transfer operators, booking references or internal notes, and never a price per item, even when the agency shows line prices on the page. The venues' own names and links stay.

Path parameters

idstring

Query parameters

variantstringoptional
The id of one of the trip's options (see Trip variants). Default: the one the client page shows. After the client accepts an option, only that one can be read.

Returns

An Itinerary object.

object"itinerary"
trip_idstring
The trip it belongs to.
variant_idstring or null
The option this itinerary is, when the trip has options.
languageenum
The language of the proposal (ISO 639-1). Every text in this itinerary is as the client page shows it: the translation into this language when there is one, otherwise the text as the agency wrote it.
enesfrdenlsvnbdaptit
titlestring
The trip name the client sees.
priceobject or null
The package price the client is quoted. Null while there is nothing to price. Once payments are recorded, the client page shows what was scheduled and paid instead of the quote; that total can differ (extras added later).
+ Show 8 child attributes− Hide 8 child attributes
per_golfermoney or null
+ Show 2 child attributes− Hide 2 child attributes
amountinteger
Integer minor units of the currency: 125000 EUR is €1,250.00.
currencystring
ISO 4217 code.
per_non_golfermoney or null
+ Show 2 child attributes− Hide 2 child attributes
amountinteger
Integer minor units of the currency: 125000 EUR is €1,250.00.
currencystring
ISO 4217 code.
group_totalmoney
+ Show 2 child attributes− Hide 2 child attributes
amountinteger
Integer minor units of the currency: 125000 EUR is €1,250.00.
currencystring
ISO 4217 code.
deposit_percentnumber or null
deposit_per_personmoney or null
A fixed deposit per person, when the agency set one instead of a percent. Then deposit_percent is null.
+ Show 2 child attributes− Hide 2 child attributes
amountinteger
Integer minor units of the currency: 125000 EUR is €1,250.00.
currencystring
ISO 4217 code.
deposit_groupmoney or null
A fixed deposit for the whole group, when the agency set one. Then deposit_percent and deposit_per_person are null.
+ Show 2 child attributes− Hide 2 child attributes
amountinteger
Integer minor units of the currency: 125000 EUR is €1,250.00.
currencystring
ISO 4217 code.
surcharge_notestring or null
supplementsarray of object
What some travellers pay on top of their price.
+ Show 3 child attributes− Hide 3 child attributes
labelstring
namesstring
totalmoney
+ Show 2 child attributes− Hide 2 child attributes
amountinteger
Integer minor units of the currency: 125000 EUR is €1,250.00.
currencystring
ISO 4217 code.
includesarray of string
"What's included", as the client page lists it.
staysarray of object
Where the group sleeps, one entry per hotel stay.
+ Show 4 child attributes− Hide 4 child attributes
first_nightinteger
Day number of the stay's first night.
last_nightinteger
nightsinteger
hotelHotel
+ Show 9 child attributes− Hide 9 child attributes
namestring or null
starsinteger or null
roomsstring or null
The rooms line the client reads, e.g. "2× Double · Breakfast included".
descriptionstring or null
additional_infostring or null
amenitiesarray of string
websitestring or null
imagesarray of string
extrasobject
Extras arranged with this element. Labels only, never prices.
+ Show 2 child attributes− Hide 2 child attributes
includedarray of string
Extras the package covers, as the client reads them ("2× Caddie").
at_venuearray of string
Extras the client pays at the venue. Their reference prices are on the client page, not here.
splitsarray of object
Days where the group splits into two or three groups, each with its own items and, optionally, its own hotel. Empty when the trip never splits.
+ Show 3 child attributes− Hide 3 child attributes
first_dayinteger
last_dayinteger
groupsarray of object
+ Show 5 child attributes− Hide 5 child attributes
namestring
travellersarray of string
Traveller names, or null when the trip uses counts instead of named travellers.
traveller_countinteger
hotelHotel or null
The group's own hotel on these nights; null when the group stays in the trip hotel.
+ Show 9 child attributes− Hide 9 child attributes
namestring or null
starsinteger or null
roomsstring or null
The rooms line the client reads, e.g. "2× Double · Breakfast included".
descriptionstring or null
additional_infostring or null
amenitiesarray of string
websitestring or null
imagesarray of string
extrasobject
Extras arranged with this element. Labels only, never prices.
+ Show 2 child attributes− Hide 2 child attributes
includedarray of string
Extras the package covers, as the client reads them ("2× Caddie").
at_venuearray of string
Extras the client pays at the venue. Their reference prices are on the client page, not here.
item_idsarray of string
The ids of the day items in this group's column.
daysarray of object
The trip day by day.
+ Show 5 child attributes− Hide 5 child attributes
day_numberinteger
datedate or null
YYYY-MM-DD.
base_campstring or null
notesstring or null
itemsarray of day items
+ Show 65 child attributes− Hide 65 child attributes

type: course

type"course"
idstring
namestring or null
tee_timestring or null
As the agency typed it: "09:30", "09:00–10:00", "TBD".
locationstring or null
why_recommendedstring or null
descriptionstring or null
additional_infostring or null
websitestring or null
imagesarray of string
factsobject
+ Show 4 child attributes− Hide 4 child attributes
holesinteger or null
parinteger or null
architectstring or null
year_openedinteger or null
top100object or null
+ Show 2 child attributes− Hide 2 child attributes
rankinteger
countrystring
notable_infostring or null
extrasobject
Extras arranged with this element. Labels only, never prices.
+ Show 2 child attributes− Hide 2 child attributes
includedarray of string
Extras the package covers, as the client reads them ("2× Caddie").
at_venuearray of string
Extras the client pays at the venue. Their reference prices are on the client page, not here.

type: flight, ferry, train, eurotunnel

typeenum
flightferrytraineurotunnel
idstring
titlestring or null
fromstring or null
tostring or null
departure_timestring or null
arrival_timestring or null
descriptionstring or null
audienceenum
Who takes part. everyone unless the agency set it.
everyonegolfersnon_golfers
booked_by_clientboolean
In the plan, not in the price: the client books it.

type: transfer

type"transfer"
idstring
titlestring
The service, e.g. "Private transfer · Airport to hotel".
timestring or null
Pick-up time.
end_timestring or null
Drop-off time; null without a pick-up time.
descriptionstring or null
audienceenum
Who takes part. everyone unless the agency set it.
everyonegolfersnon_golfers

type: restaurant

type"restaurant"
idstring
namestring or null
menustring or null
timestring or null
descriptionstring or null
additional_infostring or null
websitestring or null
imagesarray of string
audienceenum
Who takes part. everyone unless the agency set it.
everyonegolfersnon_golfers
paymentenum
a_la_carte: the group orders and pays at the restaurant.
includeda_la_carte
extrasobject
Extras arranged with this element. Labels only, never prices.
+ Show 2 child attributes− Hide 2 child attributes
includedarray of string
Extras the package covers, as the client reads them ("2× Caddie").
at_venuearray of string
Extras the client pays at the venue. Their reference prices are on the client page, not here.

type: activity

type"activity"
idstring
namestring or null
optionstring or null
timestring or null
end_timestring or null
descriptionstring or null
additional_infostring or null
imagesarray of string
audienceenum
Who takes part. everyone unless the agency set it.
everyonegolfersnon_golfers
extrasobject
Extras arranged with this element. Labels only, never prices.
+ Show 2 child attributes− Hide 2 child attributes
includedarray of string
Extras the package covers, as the client reads them ("2× Caddie").
at_venuearray of string
Extras the client pays at the venue. Their reference prices are on the client page, not here.

type: drive

type"drive"
idstring
titlestring or null
fromstring or null
tostring or null
durationstring or null
departure_timestring or null
descriptionstring or null

type: note

type"note"
idstring
textstring

Errors

401unauthorizedNo key, a malformed one, or a key that does not exist or was revoked. Send it as Authorization: Bearer <key>.
403api_not_enabledRoundPlan has not turned on API access for this agency.
403subscription_inactiveThe agency's trial expired or its subscription ended.
403insufficient_scopeThe key cannot read this. An owner adds trips:read to a key in Settings → API.
400invalid_requestA query parameter is not valid. The message says which.
404not_foundThe trip does not exist in this agency or has no itinerary yet, or the option asked for does not exist or is no longer shown to the client.
429rate_limitedToo many requests. Wait the seconds in Retry-After. See Errors and rate limits.
500internal_errorSomething went wrong on our side. Retry later.