WhosOff icon

WhosOff

Absence and leave management for employees, managers, and HR teams.

38 searches39 actionsPollingAuth: API key

AI-assisted documentation19 min read

This documentation is compiled from our integration source code, internal specs for WhosOff, its official API documentation and anonymized requests logs we collect from our support team[2].

Open WhosOff on WEXTL →

Before you set up the credential, make sure you have an active WhosOff account and an API access token from your account settings ready.[3]

  • Base URLurlRequired

    The root URL of your API (e.g. https://yourcompany.whosoff.com). Do not include a trailing slash.

    [1]
  • UsernametextRequired

    Your login username (usually your email address).

    [1]
  • PasswordpasswordRequired

    Your login password.

    [1]
  • App IDtextRequired

    The App ID provided by WhosOff (maximum 16 characters). To obtain it: Log in as a Super User → Go to Company Settings → API section.

    [1]
  • SecretpasswordRequired

    The Client Secret for your application (maximum 160 characters). Obtain it in Company Settings (as Super User) under the API section. You will use this secret together with a random nonce to generate a SHA512 hash during authentication.

    [1]
  1. Log in to your WEXTL account, add the WhosOff node module to your workflow, and click Create new credential.
  2. Optional: In the Credential name field, enter a name for the credential.
  3. Enter the authentication credentials you copied from your WhosOff account, or follow the on-screen instructions to create the credential.
  4. If prompted, authenticate your account and confirm access.
  5. If you want to make changes to your credential in the future, follow the steps in Manage credentials →

Notes

Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →

Get a CalendarSearch
Input fields[3]
FieldType
Map TypeRequired
choice
Map IDRequired
number
Start DateRequired
date
End DateRequired
date
Leave Typesarray
Include Free/RestrictedRequired
boolean
Include Only Who's OffRequired
boolean
Limitnumber
Output fields[3]
FieldType
Object nametext
Typetext
Is nullableboolean
Nestarray
Customtext
Notetext
Get a Calendar SummaryAction
Input fields[3]
FieldType
Map TypeRequired
choice
Map IDRequired
choice
Month (1-12)Required
date
YearRequired
date
Limitnumber
Output fields[3]
FieldType
Object nametext
Typetext
Is nullableboolean
Nesttext
Customtext
Notetext
Get a Company MessageAction
Input fields[3]
FieldType
Start DateRequired
date
End DateRequired
date
Map Typechoice
Map IDchoice
Limitnumber
Output fields[3]
FieldType
Object nametext
Typetext
Is nullableboolean
Nesttext
Customtext
Notetext
Get a DepartmentSearch
Input fields[3]
FieldType
Department IDchoice
Limitnumber
Output fields[3]
FieldType
Object nametext
Typetext
Is nullableboolean
Nesttext
Customtext
Notetext
Get a LeaveSearch
Input fields[3]
FieldType
Map TypeRequired
choice
Map IDRequired
number
User Statuschoice
Leave Typesarray
Date OptionRequired
choice
Start Date (Required for Custom)date
End Date (Required for Custom)date
Statuschoice
Limitnumber
Output fields[3]
FieldType
User IDnumber
Email addressemail
Nametext
Date createddate
Get a Leave by IDAction
Input fields[3]
FieldType
Leave IDRequired
choice
Output fields[3]
FieldType
Object nametext
Typetext
Is nullableboolean
Nesttext
Customtext
Notetext
Get a Leave TypeSearch
Input fields[3]
FieldType
StatusRequired
choice
Limitnumber
Output fields[3]
FieldType
User IDnumber
Email addressemail
Nametext
Get a Message by IDAction
Input fields[3]
FieldType
Company Message IDRequired
choice
Output fields[3]
FieldType
Object nametext
Typetext
Is nullableboolean
Nesttext
Customtext
Notetext
Get a System MessageSearch
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Object nametext
Typetext
Is nullableboolean
Nesttext
Customtext
Notetext
Get a TagSearch
Input fields[3]
FieldType
Tag IDchoice
Limitnumber
Output fields[3]
FieldType
Object nametext
Typetext
Is nullableboolean
Nesttext
Customtext
Notetext
Get a UserAction
Input fields[3]
FieldType
UserRequired
choice
Output fields[3]
FieldType
Object nametext
Typetext
Is nullableboolean
Nesttext
Customtext
Notetext
Get a UserSearch
Input fields[3]
FieldType
Map TypeRequired
choice
Map IDRequired
number
Last Name Filtertext
StatusRequired
choice
Limitnumber
Output fields[3]
FieldType
Object nametext
Typetext
Is nullableboolean
Nesttext
Customtext
Notetext
Get a UserSearch
Input fields[3]
FieldType
Map TypeRequired
choice
Map IDRequired
number
Last Name Filtertext
StatusRequired
choice
Limitnumber
Output fields[3]
FieldType
Object nametext
Typetext
Is nullableboolean
Nesttext
Customtext
Notetext
Get a User AllowanceSearch
Input fields[3]
FieldType
Start DateRequired
date
End DateRequired
date
Limitnumber
Output fields[3]
FieldType
Object nametext
Typetext
Is nullableboolean
Nesttext
Customtext
Notetext
Get a User NoteAction
Input fields[3]
FieldType
UserRequired
choice
Output fields[3]
FieldType
User IDnumber
Email addressemail
Nametext
Get a User's Leave TypeSearch
Input fields[3]
FieldType
Statuschoice
Optionchoice
Limitnumber
Output fields[3]
FieldType
Object nametext
Typetext
Is nullableboolean
Nesttext
Customtext
Notetext
Get a User's MapSearch
Input fields[3]
FieldType
UserRequired
choice
Limitnumber
Output fields[3]
FieldType
Object nametext
Typetext
Is nullableboolean
Nesttext
Customtext
Notetext
Get ApproversSearch
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Object nametext
Typetext
Is nullableboolean
Nesttext
Customtext
Notetext
Get CalendarSearch
Input fields[3]
FieldType
Map TypeRequired
choice
Map IDRequired
number
Start DateRequired
date
End DateRequired
date
Leave Typesarray
Include Free/RestrictedRequired
boolean
Include Only Who's OffRequired
boolean
Limitnumber
Output fields[3]
FieldType
Object nametext
Typetext
Is nullableboolean
Nestarray
Customtext
Notetext
Get Calendar DetailsAction
Input fields[3]
FieldType
Leave IDRequired
choice
Output fields[3]
FieldType
Object nametext
Typetext
Is nullableboolean
Nesttext
Customtext
Notetext
Get LeaveAction
Input fields[3]
FieldType
Map TypeRequired
choice
Map IDRequired
number
User Statuschoice
Leave Typesarray
Date OptionRequired
choice
Start Date (Required for Custom)date
End Date (Required for Custom)date
Statuschoice
Limitnumber
Output fields[3]
FieldType
Object nametext
Typetext
Is nullableboolean
Nesttext
Customtext
Notetext
Get Leave by IDAction
Input fields[3]
FieldType
Leave IDRequired
choice
Output fields[3]
FieldType
User IDnumber
Email addressemail
Nametext
Get Leave Type by IDAction
Input fields[3]
FieldType
Leave TypeRequired
choice
Output fields[3]
FieldType
Object nametext
Typetext
Is nullableboolean
Nesttext
Customtext
Notetext
Get My LeaveAction
Input fields[3]
FieldType
Date OptionRequired
choice
Start Date (Required for Custom)date
End Date (Required for Custom)date
Leave Typesarray
Statuschoice
Include Leaveboolean
Include Workboolean
Include Free/Restrictedboolean
Output fields[3]
FieldType
Object nametext
Typetext
Is nullableboolean
Nesttext
Customtext
Notetext
Get My OvertimeSearch
Input fields[3]
FieldType
Date OptionRequired
choice
Start Date (Required for Custom)date
End Date (Required for Custom)date
Statuschoice
Overtime Typesarray
Limitnumber
Output fields[3]
FieldType
User IDnumber
Get Overtime by IDAction
Input fields[3]
FieldType
Overtime IDRequired
choice
Output fields[3]
FieldType
Object nametext
Typetext
Is nullableboolean
Nesttext
Customtext
Notetext
Get Overtime TypeSearch
Input fields[3]
FieldType
StatusRequired
choice
Limitnumber
Output fields[3]
FieldType
Object nametext
Typetext
Is nullableboolean
Nesttext
Customtext
Notetext
Get Overtime Type by IDAction
Input fields[3]
FieldType
Overtime TypeRequired
choice
Output fields[3]
FieldType
Object nametext
Typetext
Is nullableboolean
Nesttext
Customtext
Notetext
Get Overtime Type for a UserAction
Input fields[3]
FieldType
Statuschoice
Limitnumber
Output fields[3]
FieldType
Object nametext
Typetext
Is nullableboolean
Nesttext
Customtext
Notetext
Get OvertimesSearch
Input fields[3]
FieldType
Map Typechoice
Map IDnumber
User Statuschoice
Date OptionRequired
choice
Start Date (Required for Custom)date
End Date (Required for Custom)date
Statuschoice
Overtime Typesarray
Limitnumber
Output fields[3]
FieldType
Object nametext
Typetext
Is nullableboolean
Nesttext
Customtext
Notetext
Get StaffAction
Input fields[3]
FieldType
Staff FilterRequired
choice
Start DateRequired
date
End DateRequired
date
Output fields[3]
FieldType
Object nametext
Typetext
Is nullableboolean
Nestarray
Customtext
Notetext
Get User AllowanceSearch
Input fields[3]
FieldType
UserRequired
choice
Start Datedate
End Datedate
Limitnumber
Output fields[3]
FieldType
Object nametext
Typetext
Is nullableboolean
Nesttext
Customtext
Notetext
Get User DetailsAction
Output fields[3]
FieldType
Object nametext
Typetext
Is nullableboolean
Nesttext
Customtext
Notetext
Get User RestrictionsSearch
Input fields[3]
FieldType
UserRequired
choice
Limitnumber
Output fields[3]
FieldType
Object nametext
Typetext
Is nullableboolean
Nesttext
Customtext
Notetext
Get WorkSearch
Input fields[3]
FieldType
UserRequired
choice
Start Datedate
End Datedate
Limitnumber
Output fields[3]
FieldType
User IDnumber
Email addressemail
Nametext
Date createddate
Lookup CountrySearch
Input fields[3]
FieldType
Nametext
Public Holiday Onlyboolean
Limitnumber
Output fields[3]
FieldType
Object nametext
Typetext
Is nullableboolean
Nesttext
Customtext
Notetext
Lookup ValuesSearch
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Object nametext
Typetext
Is nullableboolean
Nesttext
Customtext
Notetext
Search Map Users by TagSearch
Input fields[3]
FieldType
TagRequired
choice
Limitnumber
Output fields[3]
FieldType
Object nametext
Typetext
Is nullableboolean
Nesttext
Customtext
Notetext
Approve or Decline LeaveAction
Input fields[3]
FieldType
Leave IDRequired
choice
ActionRequired
choice
Approver Notetext
Output fields[3]
FieldType
Object nametext
Typetext
Is nullableboolean
Nesttext
Customtext
Notetext
Approve OvertimeAction
Input fields[3]
FieldType
Overtime IDRequired
choice
ActionRequired
choice
Approver Notetext
Lieu Time Approved (minutes)Required
number
Output fields[3]
FieldType
Object nametext
Typetext
Is nullableboolean
Nesttext
Customtext
Notetext
Cancel LeaveAction
Input fields[3]
FieldType
Leave IDRequired
choice
Cancellation Notetext
AdminRequired
boolean
Output fields[3]
FieldType
Object nametext
Typetext
Is nullableboolean
Nesttext
Customtext
Notetext
Cancel OvertimeAction
Input fields[3]
FieldType
Overtime IDRequired
choice
Cancellation Notetext
AdminRequired
boolean
Output fields[3]
FieldType
User IDnumber
Create a Calendar DayAction
Input fields[3]
FieldType
Map TypeRequired
choice
Map IDRequired
text
Start DateRequired
date
End DateRequired
date
Output fields[3]
FieldType
Object nametext
Typetext
Is nullableboolean
Nesttext
Customtext
Notetext
Create a DepartmentAction
Input fields[3]
FieldType
NameRequired
text
Min UsersRequired
number
Max Usersnumber
Output fields[3]
FieldType
Object nametext
Typetext
Is nullableboolean
Nesttext
Customtext
Notetext
Create a Leave TypeAction
Input fields[3]
FieldType
NameRequired
text
CodeRequired
text
ColourRequired
text
Deduct AllowanceRequired
choice
Requires ApprovalRequired
boolean
Consecutive Duration (minutes)Required
number
Minimum DurationRequired
number
Allow Concurrent RequestsRequired
boolean
Notes Visible ToRequired
choice
Available ToRequired
choice
Seen ByRequired
choice
Min Notice Period (minutes)Required
number
Cancellation Period (minutes)Required
number
Include Department LevelRequired
boolean
Note RequiredRequired
boolean
Email RequestRequired
choice
8other input fields
Output fields[3]
FieldType
Object nametext
Typetext
Is nullableboolean
Nesttext
Customtext
Notetext
Create a Map User TagAction
Input fields[3]
FieldType
UserRequired
choice
TagRequired
choice
Output fields[3]
FieldType
Object nametext
Typetext
Is nullableboolean
Nesttext
Customtext
Notetext
Create a TagAction
Input fields[3]
FieldType
NameRequired
text
Output fields[3]
FieldType
Object nametext
Typetext
Is nullableboolean
Nesttext
Customtext
Notetext
Create a UserAction
Input fields[3]
FieldType
Staff Codetext
Titletext
First NameRequired
text
Middle Nametext
Last NameRequired
text
User TypeRequired
choice
Default View TypeRequired
choice
Default View IDnumber
Default Sortingchoice
DepartmentRequired
choice
Region IDtext
ApproverRequired
choice
Approver Rolechoice
Notifier 2Required
choice
Notifier 2 Rolechoice
Notifier 3Required
choice
12other input fields
Output fields[3]
FieldType
Object nametext
Typetext
Is nullableboolean
Nesttext
Customtext
Notetext
Create a User AllowanceAction
Input fields[3]
FieldType
UserRequired
choice
Start DateRequired
date
Opening (minutes)Required
number
Remaining (minutes)Required
number
Carryover Opening (minutes)Required
number
Carryover Remaining (minutes)Required
number
Lockedboolean
Output fields[3]
FieldType
Object nametext
Typetext
Is nullableboolean
Nesttext
Customtext
Notetext
Create a User NoteAction
Input fields[3]
FieldType
UserRequired
choice
Notetext
Create a User RestrictionAction
Input fields[3]
FieldType
UserRequired
choice
Restricted UserRequired
choice
Reverse EntryRequired
boolean
Output fields[3]
FieldType
Object nametext
Typetext
Is nullableboolean
Nesttext
Customtext
Notetext
Create an Overtime TypeAction
Input fields[3]
FieldType
NameRequired
text
CodeRequired
text
ColourRequired
text
Requires ApprovalRequired
boolean
Note RequiredRequired
boolean
Email RequestRequired
choice
Email ApproveRequired
choice
Email CancelRequired
choice
Lieu TimeRequired
boolean
StatusRequired
choice
Available ToRequired
choice
Messagetext
Output fields[3]
FieldType
Object nametext
Typetext
Is nullableboolean
Nesttext
Customtext
Notetext
Create WorkAction
Input fields[3]
FieldType
UserRequired
choice
Start DateRequired
date
Monday (minutes)Required
number
Tuesday (minutes)Required
number
Wednesday (minutes)Required
number
Thursday (minutes)Required
number
Friday (minutes)Required
number
Saturday (minutes)Required
number
Sunday (minutes)Required
number
Allowance TypeRequired
choice
Monday Labelnumber
Tuesday Labelnumber
Wednesday Labelnumber
Thursday Labelnumber
Friday Labelnumber
Saturday Labelnumber
1other input field
Output fields[3]
FieldType
Object nametext
Typetext
Is nullableboolean
Nesttext
Customtext
Notetext
Decline Leave by IDAction
Input fields[3]
FieldType
Leave IDRequired
choice
Output fields[3]
FieldType
Object nametext
Typetext
Is nullableboolean
Nesttext
Customtext
Notetext
Delete a DepartmentAction
Input fields[3]
FieldType
DepartmentRequired
choice
Force RemovalRequired
boolean
Delete a Leave TypeAction
Input fields[3]
FieldType
Leave TypeRequired
choice
Force RemovalRequired
boolean
Delete a Map User TagAction
Input fields[3]
FieldType
User Tag IDRequired
choice
Delete a TagAction
Input fields[3]
FieldType
TagRequired
choice
Force RemovalRequired
boolean
Delete a UserAction
Input fields[3]
FieldType
UserRequired
choice
Delete a User AllowanceAction
Input fields[3]
FieldType
UserRequired
choice
Delete a User NoteAction
Input fields[3]
FieldType
UserRequired
choice
Delete a User RestrictionAction
Input fields[3]
FieldType
UserRequired
choice
User Restriction IDRequired
choice
Delete an Overtime TypeAction
Input fields[3]
FieldType
Overtime TypeRequired
choice
Force RemovalRequired
boolean
Delete WorkAction
Input fields[3]
FieldType
Work IDRequired
choice
Make an API Calluniversal
Input fields[3]
FieldType
URLRequired
text
MethodRequired
choice
Headersarray
Headerobject
Query Stringarray
Parameterobject
Bodytext
Output fields[3]
FieldType
Bodytext
Headersobject
Status codenumber
Submit LeaveAction
Input fields[3]
FieldType
Leave IDchoice
Userchoice
Leave TypeRequired
choice
Start DateRequired
date
End DateRequired
date
Notetext
AdminRequired
boolean
Output fields[3]
FieldType
Object nametext
Typetext
Is nullableboolean
Nesttext
Customarray
Notetext
Submit OvertimeAction
Input fields[3]
FieldType
Userchoice
Overtime TypeRequired
choice
Start DateRequired
date
Duration (minutes)Required
number
Lieu Time Requested (minutes)number
Notetext
AdminRequired
boolean
Output fields[3]
FieldType
Object nametext
Typetext
Is nullableboolean
Nesttext
Customtext
Notetext
Unlock a UserAction
Input fields[3]
FieldType
UserRequired
choice
Update a DepartmentAction
Input fields[3]
FieldType
DepartmentRequired
choice
Nametext
Min Usersnumber
Max Usersnumber
Update a Leave TypeAction
Input fields[3]
FieldType
Leave TypeRequired
choice
Nametext
Codetext
Colourtext
Deduct Allowancechoice
Requires Approvalboolean
Consecutive Duration (minutes)number
Minimum Durationnumber
Allow Concurrent Requestsboolean
Notes Visible Tochoice
Available Tochoice
Seen Bychoice
Min Notice Period (minutes)number
Cancellation Period (minutes)number
Include Department Levelboolean
Note Requiredboolean
9other input fields
Output fields[3]
FieldType
Object nametext
Typetext
Is nullableboolean
Nesttext
Customtext
Notetext
Update a TagAction
Input fields[3]
FieldType
TagRequired
choice
NameRequired
text
Update a UserAction
Input fields[3]
FieldType
UserRequired
choice
Staff Codetext
Titletext
First Nametext
Middle Nametext
Last Nametext
User Typechoice
Default View Typechoice
Default View IDnumber
Default Sortingchoice
Departmentchoice
Region IDnumber
Approverchoice
Approver Rolechoice
Notifier 2choice
Notifier 2 Rolechoice
11other input fields
Output fields[3]
FieldType
Object nametext
Typetext
Is nullableboolean
Nesttext
Customtext
Notetext
Update a User AllowanceAction
Input fields[3]
FieldType
UserRequired
choice
Opening (minutes)number
Remaining (minutes)number
Carryover Opening (minutes)number
Carryover Remaining (minutes)number
Lockedboolean
Output fields[3]
FieldType
Object nametext
Typetext
Is nullableboolean
Nesttext
Customtext
Notetext
Update a User NoteAction
Input fields[3]
FieldType
UserRequired
choice
Notetext
Update Overtime TypeAction
Input fields[3]
FieldType
Overtime TypeRequired
choice
Nametext
Codetext
Colourtext
Requires Approvalboolean
Note Requiredboolean
Email Requestchoice
Email Approvechoice
Email Cancelchoice
Lieu Timeboolean
Statuschoice
Available Tochoice
Messagetext
Output fields[3]
FieldType
Object nametext
Typetext
Is nullableboolean
Nesttext
Customtext
Notetext
Update WorkAction
Input fields[3]
FieldType
Work IDRequired
choice
Userchoice
Start Datedate
Monday (minutes)number
Tuesday (minutes)number
Wednesday (minutes)number
Thursday (minutes)number
Friday (minutes)number
Saturday (minutes)number
Sunday (minutes)number
Allowance Typechoice
Monday Labelnumber
Tuesday Labelnumber
Wednesday Labelnumber
Thursday Labelnumber
Friday Labelnumber
2other input fields
Output fields[3]
FieldType
Object nametext
Typetext
Is nullableboolean
Nesttext
Customtext
Notetext
Validate LeaveAction
Input fields[3]
FieldType
Leave IDchoice
Userchoice
Leave TypeRequired
choice
Start DateRequired
date
End DateRequired
date
Adminboolean
Notetext
Output fields[3]
FieldType
Object nametext
Typetext
Is nullableboolean
Nesttext
Customarray
Notetext

Look for WhosOff templates in the WEXTL template library.

Browse templates →
  1. WEXTL® WhosOff Source Code connector implementation.
  2. Our users use cases and automations.
  3. Official API Documentation for WhosOff.
  4. WEXTL® visual workflow builder data.

Last updated: Jul 24, 2026 18:13