Skip to navigation

Get Trip Details

View as Markdown

Get Trip Details

Returns the trip with all its legs (itineraries), dates, budgets and the bookings linked to each leg. Use the itineraryId of a leg as tripItineraryId when pushing bookings. If the trip was saved as <tripId>_<id>, pass the original tripId with employeeCode or employeeEmail.

Request Parameters

ParamRequiredDescription
tripIdMandatoryTrip reference (as returned by Create Trip).
employeeCodeOptionalTrip owner’s employee code. Optional – helps resolve trips saved as <tripId>_<id>.
employeeEmailOptionalTrip owner’s email. Used when employeeCode is not sent.

Path parameters

tripIdstringRequired

Trip reference (as returned by Create Trip).

Headers

DICE-APP-IDstringOptional
Company Code of client
X-CLIENT-IDstringOptional
API Client ID
X-CLIENT-SECRETstringOptional
API Client Secret

Query parameters

employeeCodestringOptional

Trip owner’s employee code. Optional – helps resolve trips saved as <tripId>_<id>.

employeeEmailstringOptionalformat: "email"

Trip owner’s email. Used when employeeCode is not sent.

Response

OK
idlongOptional
Internal Dice trip id.
tripIdstringOptional
Trip reference.
titlestringOptional
Trip title.
tripStatusstringOptional

Current Dice trip status: PENDING (approved / active), APPROVAL (waiting for approvers), COMPLETED (travel completed), CANCELLED or DECLINED.

statusenumOptional

Time-based state, present when both dates exist.

Allowed values:
activebooleanOptional

true while the current time is between start and end date.

startDatelongOptional

Trip start. Epoch time in milliseconds (UTC).

endDatelongOptional

Trip end. Epoch time in milliseconds (UTC).

startDateFormattedstringOptional
Formatted start date.
endDateFormattedstringOptional
Formatted end date.
descriptionstringOptional

<start> - <end> summary.

imagestringOptional

Cover image (first destination city).

budgetlongOptional

Total trip budget (travel + stay + allowance + additional amount).

selfBookingbooleanOptional

true if the employee books services themselves; false for admin / travel-desk booking.

itinerarieslist of objectsOptional
Trip legs in order.