RoundPlanAPI reference

Objects

Trip

A trip as its client sees it: title, status, destination, dates and travellers, without internal costs or margins.

Attributes

object"trip"
idstring
Unique id of the trip.
titlestring
The trip name the client sees.
statusenum
Where the trip is in its life, from proposal to completed.
proposalplanningconfirmedactivecompleteddeclinedcancelled
destinationobject
Where the trip happens.
+ Show 2 child attributes− Hide 2 child attributes
regionstring or null
The region the client sees, for example Costa Brava.
base_campstring or null
The town the group stays in.
datesobject
When the trip happens.
+ Show 4 child attributes− Hide 4 child attributes
modeenum
fixed when a start date is recorded; flexible when the trip has a length but no calendar yet.
fixedflexible
start_datedate or null
First day. Null when the dates are flexible. YYYY-MM-DD.
end_datedate or null
Last day, inclusive. Null when no end date is recorded: a trip with only a start date still has mode: fixed. YYYY-MM-DD.
num_daysinteger
Length in days, always set.
travelersobject
How many people travel.
+ Show 2 child attributes− Hide 2 child attributes
golfersinteger
Travellers who play.
non_golfersinteger or null
Travellers who don't play. Always null in lists (not loaded there). On GET /trips/{id}, a number when the trip has an itinerary, otherwise null.
client_pageobject
The page the client sees.
+ Show 2 child attributes− Hide 2 child attributes
publishedboolean
The client page is live.
urlstring or null
The client page's address, when it is live.
accepted_attimestamp or null
When the client accepted the proposal. ISO 8601, UTC.
created_attimestamp
When it was created. ISO 8601, UTC.
updated_attimestamp
Its last change. Use it with updated_since to sync. ISO 8601, UTC.