Sign in

v1

latestOpenAPI 3.0.22026-07-26191278525.6 KB
Booking

Get Booking

Given a Booking id, it returns all attributes of the Booking (Resource Management Entity)

get/api/v2/resource_management/bookings/{bookingId}

Path parameters

bookingIdstring required

ID of a booking in Eightfold

Query parameters

includestring

Include additional fields in the response. Possible values are extData

excludestring

Exclude specific fields in the response. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.

keyListstring

Allows selective control over the fields returned in the API response. If the keyList is empty, all fields will be returned. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.

Headers

Authorizationstring required

The secret key to access the api. It starts with the bearer token

Response

OK

createdAtinteger nullable

Created timestamp for the booking

updatedBystring nullable

User who updated the booking

isArchivedboolean nullable

A flag indicating if booking is archived

startDateIsostring

Start date of the booking in ISO format (YYYY-MM-DD)

capacitynumber float required

Booked capacity of employee

startDateinteger

[DEPRECATED] Start date of the booking. Use startDateIso instead.

archivedAtinteger nullable

Archived timestamp for the booking

bookingStatus'pending' | 'approved' | 'rejected' required

Status of the booking. Possible values: ['pending', 'approved', 'rejected']

bookingIdinteger nullable

Booking id

demandIdinteger nullable

Demand id associated with the booking

endDateinteger

[DEPRECATED] End date of the booking. Use endDateIso instead.

updatedAtinteger nullable

Updated timestamp for the booking

employeeProfileIdinteger nullable

Profile ID of the employee

bookingType'demand' | 'leave' | 'optional_holiday' | 'blocker' required

Type of the booking. Possible values: ['demand', 'leave', 'optional_holiday', 'blocker']

endDateIsostring

End date of the booking in ISO format (YYYY-MM-DD)

createdBystring nullable

User who created the booking

employeeEmailstring required

Email of employee