Time offs

List all time-off types

const leaveTypes = await ft.timeOffs.types();
// use leaveTypes.json() to access data
  • Returns a Promise that resolves to an Array of Freshteam.models.LeaveType objects

Get time-off type by ID

const leaveType = await ft.timeOffs.type(id);
// use leaveType.json() to access data
  • Returns a Promise that resolves to a Freshteam.models.LeaveType object

List all time-off requests

const leaveReqList = await ft.timeOffs.list(query);
// use leaveReqList.json() to access data

Create a time-off

const newLeaveReq = await ft.timeOffs.create(leaveRequest);
// use newLeaveReq.json() to access data
  • Returns a Promise that resolves to a Freshteam.models.LeaveRequest object
  • The first argument is an object of type Freshteam.models.LeaveRequestCreate

Get time-off by ID

const leave = await ft.timeOffs.get(id);
// use leave.json() to access data
  • Returns a Promise that resolves to a Freshteam.models.LeaveRequest object

Approve time-off by ID

const res = await ft.timeOffs.approve(id, options);
// use res.json() to access data
  • Returns a Promise that resolves to null if request was successful
  • The second argument is an object of type Freshteam.models.LeaveRequestApprove

Reject time-off by ID

const res = await ft.timeOffs.reject(id, options);
// use res.json() to access data
  • Returns a Promise that resolves to null if request was successful
  • The second argument is an object of type Freshteam.models.LeaveRequestReject

Cancel time-off by ID

const res = await ft.timeOffs.cancel(id);
// use res.json() to access data
  • Returns a Promise that resolves to null if request was successful
Last Updated: