Welcome to the WhosOff API, which you can use to integrate into your other applications and work flows.
This outlines the Remote API provided WhosOff®. Primarily this API has been developed for integration with account holders’ internal systems.
The API requires authorisation and is not availble with trial accounts.
To gain access to the API, a super user of the account must request access via email and supply external IP addresses within the mail.
The service is locked down by IP address(es) and supplied server key.
Each call requires a system key (which is case sensitive) supplied by WhosOff®; this is added to provide another level of security. WhosOff® reserves the right to change system key or remove access at any time without prior notice.
Whilst we do not operate rate limiting, from time to time we will monitor your usage of the service, and where necessary we may implement restrictions without notice.
Use of this API and associated data is at your own risk and responsibility, please be aware that we do not implement any of the data rules applied by the online system eg ‘cross dept viewing’ and other leave associated restrictions. If required, you will need to implement this in your own application. At the present time the API only returns read-only data.
The following samples show typical responses you may see.
{ "Data": [ { "Name": "Holiday / Vacation" }, { "Name": "Out of Office" } ] }
{ "Error_Message": "Date range can only be for a maximum of 365 days" }
Retrieve staff details including tags and allowances.
api/v3/staff
api/v3/staff/5a43dee9-d7c7-4e5e-b796-aa03e215b904
api/v3/staff?first_name=Jane
{ "Data": [ { "Staff_ID": "5a43dee9-d7c7-4e5e-b796-aa03e215b904", "Staff_Code": "", "First_Name": "Jane", "Last_Name": "Smith", "Email_Address": "testuser1@WhosOff.com", "Department_ID": "b9c7cc05-99d0-4ebb-927f-7325fe900d7a", "Department_Name": "IT", "Notes": "", "Approver_ID": "cd2650f4-9c8b-4658-b827-aa800853aab8", "Approver_Email": "Jane@whosoff.com", "Approver_First_Name": "John", "Approver_Last_Name": "Smith", "Second_Notifier_ID": null, "Second_Notifier_Email": "", "Second_Notifier_First_Name": "", "Second_Notifier_Last_Name": "", "Third_Notifier_ID": null, "Third_Notifier_Email": "", "Third_Notifier_First_Name": "", "Third_Notifier_Last_Name": "", "Allowance_Type": "HOURS", "Sunday_Work": false, "Monday_Work": true, "Tuesday_Work": true, "Wednesday_Work": true, "Thursday_Work": true, "Friday_Work": true, "Saturday_Work": false, "Sunday_Work_Hours": 0, "Monday_Work_Hours": 8, "Tuesday_Work_Hours": 8, "Wednesday_Work_Hours": 8, "Thursday_Work_Hours": 8, "Friday_Work_Hours": 7.5, "Saturday_Work_Hours": 0, "Allowance": [ { "Company_Year": 2017, "Opening_Balance": 150, "Remaining_Balance": 74.5, "Carryover": 0, "Lieu_Time": 0 } ], "Tag": [ "Zone 1", "IT", "sales", "UK - Sales", "Driver tag" ] } ] }
Start Your Free Trial