Time Off

These are the endpoints that are available under the /timeOff path, which shows what hours your staff has taken off. Please note that to create new periods of time off, you POST to the /timeOffBulk path, and also please note that you can view multiple time offs by simply posting a GET call to the /appointments/report path with the excludeTimeOff parameter set to false and the onlyTimeOff parameter set to 1. For more information about GET /appointments/report calls, please refer to the Appointments API page.

Endpoint	Description
GET /appointments/report	Returns an array of appointments. To get time offs to return, set the excludeTimeOff parameter to false and set the onlyTimeOff parameter to 1.
GET /timeOff/{timeOffId}	Returns a JSON object for specified time off.
POST /timeOffBulk	Creates a new time off object on a business' account. Request body/payload: Must pass a full appointment object.
PUT /timeOff/{timeOffId}	Updates an existing time off object. Request body/payload: Must pass an appointment with the desired changes made.
DELETE /timeOff/{timeOffId}	Deletes a timeOff object from your business' account.

To aid with page load time, we have included pageNumber and pageSize parameters for server side pagination.

Parameter	Type	Endpoints to be used with	Description
clientId	integer	GET /appointments/report	Displays unique numeric ID of client of appointment to be returned following a GET report call.

GET /timeOff/{timeOffId}

{
    "businessId": 43111,
    "color":
    "createdDate": "2018-08-03 14:39:38",
    "createdUser": "JoeSchmo",
    "description": "Need a break!",
    "endDate": "2018-10-01",
    "endTime": 1200,
    "modifiedDate": "2018-08-07 15:10:27",
    "modifiedUser": "JoeSchmo",
    "reason": {Reason object for reason of time off-see services API page},
    "recurringAppointmentId": null,
    "staff": {Staff object for staff with time off-see staff API page},
    "startDate": "2018-10-01",
    "startTime": 1100,
    "status": "Open",
    "timeOffId": 17360947
}

POST /timeOffBulk

{
    "appliesTo": "staff",
    "assignedTo": "select",
    "businessId": "43111",
    "description": "Need a day off",
    "endDate": "2018-08-23",
    "endTime": "2400",
    "note": "Need a day off",
    "reason": {Reason object for reason of time off-see services API page},
    "repeats": false,
    "staffId": [81155],
    "startDate": "2018-08-23",
    "startTime": "0000"
}

PUT /timeOff/{timeOffId}

{
    "appliesTo": "staff",
    "businessId": 43111,
    "color": null,
    "createdDate": "2018-08-03 14:39:38",
    "createdUser": "JoeSchmo",
    "description": "Need a longer break!",
    "endDate": "2018-10-01",
    "endTime": "1400",
    "modifiedDate": "2018-08-07 11:34:56",
    "modifiedUser": "JoeSchmo",
    "note": "Need a longer break!",
    "originalStartDate": "2018-10-01",
    "reason": {Reason object for reason of time off-see services API page},
    "recurringAppointmentId": null,
    "staff": {Staff object for staff with time off-see staff API page},
    "staffId": 80891,
    "startDate": "2018-10-01",
    "startTime": "1100",
    "status": "1100",
    "timeOffId": 17360947
}

For the appointments report endpoint, please refer to the Appointments API page.

Property name	Type	Description
businessId	integer	Provides unique numeric ID of the business offering availability. (Required)
color	string	Displays any color chosen to override specified time off on the backoffice calendar.
createdDate	string	Displays as date specified time off was created as YYYY-MM-DD with time after. (Required)
createdUser	string	Displays the username of user who created specified time off. (Required)
description	string	Displays any description that was added to time off profile.
endDate	string	Displays the date that specified time off is set to end. (Required)
endTime	integer	Displays as military time that specified session ends.
modifiedDate	string	Displays as date specified time off was last modified as YYYY-MM-DD with time after.
modifiedUser	string	Displays the username of user who last modified specified time off.
reason	object	Displays the reason object connected to specified time off.
recurringAppointmentId	integer	If specified time off is part of a repeating appointment series, then this provides unique numeric ID of that repeating appointment series.
staff	object	Displays the staff object connected to specified time off.
startDate	string	Displays the date that specified time off is set to begin.
startTime	integer	Displays as military time that specified session is set to begin. (Required)
status	string	Displays the status of time off. Possible values include Open, Closed, or Cancelled.
timeOffId	integer	Provides unique numeric ID of specified time off. (Required)

Time Off API Endpoints

Time Off Parameters

Time Off API Responses

Time Off Object Values