FreshTeam icon

FreshTeam

HR platform for recruiting, employee records, time off, and organizational structure.

10 triggers19 searches12 actionsPollingAuth: API key

AI-assisted documentation21 min read

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

Open FreshTeam on WEXTL →

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

  • Freshteam - Sub DomaintextRequired

    You can take sub-domain from Freshteam URL, for example: mycompany.freshteam.com. You need to paste only mycompany.

    [1]
  • Freshteam - API KeypasswordRequired

    To get your API key, log into your account, click your Profile Avatar (top-right), select API Key (or Profile Settings/API Settings), and then copy the key displayed there; you might need to complete a CAPTCHA for security, and the key allows integrations to access your data.

    [1]
  1. Log in to your WEXTL account, add the FreshTeam 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 FreshTeam 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 →
Connecting FreshTeam to WEXTL®
Video slide demonstrates how to integrate FreshTeam in the WEXTL visual workflow builder.[4]

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 →

Watch Applicant Form Field ChangesTrigger
Output fields[3]
FieldType
IDnumber
Created atdate
Updated atdate
Deletedboolean
Applicant form IDnumber
Nametext
Field typetext
Labeltext
Positionnumber
Defaultboolean
Group labeltext
Group positiontext
Group nametext
External fieldboolean
Recruiter fieldboolean
Vendor fieldboolean
Required in vendor formboolean
Viewable bytext
Required in external formboolean
Required in recruiter formboolean
1other output field
Watch BranchesTrigger
Output fields[3]
FieldType
Branch IDnumber
Created atdate
Updated atdate
Deletedboolean
Nametext
Statetext
Citytext
Country codetext
Ziptext
Time zonetext
Currencytext
Languagetext
Main officeboolean
Date formattext
Watch Business UnitsTrigger
Output fields[3]
FieldType
Business Unit IDnumber
Created atdate
Updated atdate
Deletedboolean
Nametext
Descriptiontext
Watch DepartmentsTrigger
Output fields[3]
FieldType
Department IDnumber
Created atdate
Updated atdate
Deletedboolean
Nametext
Watch EmployeesTrigger
Output fields[3]
FieldType
Employee IDnumber
Created atdate
Updated atdate
Deletedboolean
Work numbersarray
Nick nametext
Date of birthtext
Gendertext
Addressobject
Streettext
Statetext
Citytext
Country codetext
Zip codetext
Phone numbersarray
Communication addressobject
Same as residentialboolean
Communication streettext
Communication statetext
Communication citytext
Communication country codetext
Communication zip codetext
Designationtext
Joining datetext
Branch IDnumber
Team IDnumber
Business unit IDnumber
Sub department IDtext
Department IDtext
Reporting to IDtext
Hr incharge IDtext
10other output fields
Watch Job PostingsTrigger
Output fields[3]
FieldType
Job Post IDnumber
Created atdate
Updated atdate
Deletedboolean
Titletext
Descriptiontext
Statustext
Salaryobject
Mintext
Maxtext
Currencytext
Applicant access typetext
Remoteboolean
Show pursue as careerboolean
Closing datetext
Experiencetext
Typetext
Branchobject
IDnumber
Created atdate
Updated atdate
Deletedboolean
Nametext
Statetext
Citytext
Country codetext
Ziptext
Time zonetext
Departmentobject
IDnumber
Created atdate
Updated atdate
Deletedboolean
Nametext
Watch LevelsTrigger
Output fields[3]
FieldType
Level IDnumber
Created atdate
Updated atdate
Deletedboolean
Nametext
Watch Sub DepartmentsTrigger
Output fields[3]
FieldType
Sub Department IDnumber
Created atdate
Updated atdate
Deletedboolean
Nametext
Watch TeamsTrigger
Output fields[3]
FieldType
Team IDnumber
Created atdate
Updated atdate
Deletedboolean
Nametext
Watch Time OffsTrigger
Output fields[3]
FieldType
Time Off IDnumber
Created atdate
Updated atdate
User IDnumber
Start datedate
End datedate
Statustext
Leave unitsnumber
Optional leave unitstext
Leave type IDnumber
Status commentstext
Approved by IDtext
Applied by IDnumber
Cancelled by IDtext
Rejected by IDtext
Commentstext
Rejected attext
Cancelled attext
Get a Job Type by IDAction
Input fields[3]
FieldType
Job Post IDRequired
choice
Output fields[3]
FieldType
Job Post IDnumber
Created atdate
Updated atdate
Deletedboolean
Titletext
Descriptiontext
Statustext
Salaryobject
Mintext
Maxtext
Currencytext
Applicant access typetext
Remoteboolean
Show pursue as careerboolean
Closing datetext
Experiencetext
Typetext
Branchobject
IDnumber
Created atdate
Updated atdate
Deletedboolean
Nametext
Statetext
Citytext
Country codetext
Ziptext
Time zonetext
Departmentobject
IDnumber
Created atdate
Updated atdate
Deletedboolean
Nametext
Get an Employee by IDAction
Input fields[3]
FieldType
Employee IDRequired
choice
Include Additional Fieldschoice
Output fields[3]
FieldType
Employee IDnumber
Created atdate
Updated atdate
Deletedboolean
Work numbersarray
Nick nametext
Date of birthtext
Gendertext
Addressobject
Streettext
Statetext
Citytext
Country codetext
Zip codetext
Phone numbersarray
Communication addressobject
Same as residentialboolean
Communication streettext
Communication statetext
Communication citytext
Communication country codetext
Communication zip codetext
Designationtext
Joining datetext
Branch IDnumber
Team IDnumber
Business unit IDnumber
Sub department IDtext
Department IDtext
Reporting to IDtext
Hr incharge IDtext
10other output fields
Get Employee FieldsAction
Output fields[3]
FieldType
EEmployee Field IDnumber
Created atdate
Updated atdate
Employee form IDnumber
Nametext
Labeltext
Field typetext
Positionnumber
Defaultboolean
Viewable bytext
Editable bytext
Tabtext
Field scopesarray
Get Hire by IDAction
Input fields[3]
FieldType
Hire IDRequired
text
Output fields[3]
FieldType
Hire IDnumber
Created atdate
Updated atdate
Deletedboolean
Eeo ethnicitytext
Eeo job categorytext
ID card detailstext
Workstation numbertext
Work numbersarray
Nick nametext
Date of birthtext
Marital statustext
Gendertext
Blood grouptext
Emergency contactstext
Social profilestext
Addressobject
Streettext
Citytext
Statetext
Country codetext
Zip codetext
Phone numberstext
Communication addressobject
Communication streettext
Communication citytext
Communication statetext
Communication country codetext
Communication zip codetext
Same as residentialboolean
Designationtext
36other output fields
Get Time Off by IDAction
Input fields[3]
FieldType
Time Off IDRequired
choice
Output fields[3]
FieldType
Time Off IDnumber
Created atdate
Updated atdate
User IDnumber
Start datedate
End datedate
Statustext
Leave unitsnumber
Optional leave unitstext
Leave type IDnumber
Status commentstext
Approved by IDtext
Applied by IDnumber
Cancelled by IDtext
Rejected by IDtext
Commentstext
Rejected attext
Cancelled attext
List Applicant FieldsSearch
Input fields[3]
FieldType
Job Post IDchoice
Limitnumber
Output fields[3]
FieldType
IDnumber
Created atdate
Updated atdate
Deletedboolean
Applicant form IDnumber
Nametext
Field typetext
Labeltext
Positionnumber
Defaultboolean
Group labeltext
Group positiontext
Group nametext
External fieldboolean
Recruiter fieldboolean
Vendor fieldboolean
Required in vendor formboolean
Viewable bytext
Required in external formboolean
Required in recruiter formboolean
1other output field
List BranchesSearch
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Branch IDnumber
Created atdate
Updated atdate
Deletedboolean
Nametext
Statetext
Citytext
Country codetext
Ziptext
Time zonetext
Currencytext
Languagetext
Main officeboolean
Date formattext
List Business UnitsSearch
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Business Unit IDnumber
Created atdate
Updated atdate
Deletedboolean
Nametext
Descriptiontext
List Candidate Source CategoriesSearch
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Candidate Source Category IDnumber
Created atdate
Updated atdate
Deletedboolean
Labeltext
Defaultboolean
Leads countnumber
List Candidate SourcesSearch
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Candidate Source IDnumber
Created atdate
Updated atdate
Deletedboolean
Labeltext
Defaultboolean
Leads countnumber
List DepartmentsSearch
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Department IDnumber
Created atdate
Updated atdate
Deletedboolean
Nametext
List EmployeesSearch
Input fields[3]
FieldType
Statuschoice
First Nametext
Last Nametext
Personal Emailtext
Official Emailtext
Employee Typetext
Department IDtext
Business Unit IDtext
Location IDtext
Reporting Manager IDtext
Updated Sincedate
Sort Bychoice
Sort Typechoice
Draftboolean
Terminatedboolean
Deletedboolean
Limitnumber
Output fields[3]
FieldType
Employee IDnumber
Created atdate
Updated atdate
Deletedboolean
Work numbersarray
Nick nametext
Date of birthtext
Gendertext
Addressobject
Streettext
Statetext
Citytext
Country codetext
Zip codetext
Phone numbersarray
Communication addressobject
Same as residentialboolean
Communication streettext
Communication statetext
Communication citytext
Communication country codetext
Communication zip codetext
Designationtext
Joining datetext
Branch IDnumber
Team IDnumber
Business unit IDnumber
Sub department IDtext
Department IDtext
Reporting to IDtext
Hr incharge IDtext
10other output fields
List Job Posting FieldsSearch
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Job Posting IDnumber
Created atdate
Updated atdate
Job form IDnumber
Nametext
Field typetext
Labeltext
Positionnumber
Defaultboolean
Requiredboolean
Publicboolean
Restrictedboolean
List Job PostingsSearch
Input fields[3]
FieldType
Statuschoice
Job Titletext
Job Typetext
Department IDnumber
Location IDnumber
Remotechoice
Location Citytext
Location Countrytext
Limittext
Output fields[3]
FieldType
Job Post IDnumber
Created atdate
Updated atdate
Deletedboolean
Titletext
Descriptiontext
Statustext
Salaryobject
Mintext
Maxtext
Currencytext
Applicant access typetext
Remoteboolean
Show pursue as careerboolean
Closing datetext
Experiencetext
Typetext
Branchobject
IDnumber
Created atdate
Updated atdate
Deletedboolean
Nametext
Statetext
Citytext
Country codetext
Ziptext
Time zonetext
Departmentobject
IDnumber
Created atdate
Updated atdate
Deletedboolean
Nametext
List LevelsSearch
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Level IDnumber
Created atdate
Updated atdate
Deletedboolean
Nametext
List Sub-DepartmentsSearch
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Sub Department IDnumber
Created atdate
Updated atdate
Deletedboolean
Nametext
List TeamsSearch
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Team IDnumber
Created atdate
Updated atdate
Deletedboolean
Nametext
List Time Off RequestsSearch
Input fields[3]
FieldType
Statuschoice
Employee IDchoice
Leave Type IDchoice
Location IDtext
Start Datedate
End Datedate
Limitnumber
Output fields[3]
FieldType
Time Off IDnumber
Created atdate
Updated atdate
User IDnumber
Start datedate
End datedate
Statustext
Leave unitsnumber
Optional leave unitstext
Leave type IDnumber
Status commentstext
Approved by IDtext
Applied by IDnumber
Cancelled by IDtext
Rejected by IDtext
Commentstext
Rejected attext
Cancelled attext
List TimeOff TypesSearch
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Leave Type IDnumber
Created atdate
Updated atdate
Deletedboolean
Nametext
Descriptiontext
Applicable fortext
Defaultboolean
Auto approveboolean
Auto approve aftertext
Auto approve limittext
Marital statustext
Create a Candidate SourceAction
Input fields[3]
FieldType
LabelRequired
text
Output fields[3]
FieldType
Candidate SourceI Dnumber
Created atdate
Updated atdate
Deletedboolean
Labeltext
Defaultboolean
Leads countnumber
Create a Custom Employee FieldAction
Input fields[3]
FieldType
Field LabelRequired
text
Requiredboolean
Section NameRequired
text
Field TypeRequired
choice
Create a New HireAction
Input fields[3]
FieldType
Employee IDRequired
choice
First NameRequired
text
Last NameRequired
text
StatusRequired
choice
Official Emailemail
Personal EmailRequired
email
Employee Typechoice
Work Numbersarray
Date of Birthdate
Genderchoice
Blood Groupchoice
Addressobject
Streettext
Citytext
Statetext
Country Codetext
ZIP Codetext
Communication Addressobject
Communication Streettext
Communication Citytext
Communication Statetext
Communication Country Codetext
Communication ZIP Codetext
Same as Residentialboolean
Designationtext
Joining DateRequired
date
Branch IDchoice
Team IDchoice
Business Unit IDchoice
Sub Department IDchoice
Department IDchoice
6other input fields
Output fields[3]
FieldType
Hire IDnumber
Created atdate
Updated atdate
Deletedboolean
Eeo ethnicitytext
Eeo job categorytext
ID card detailstext
Workstation numbertext
Work numbersarray
Nick nametext
Date of birthtext
Marital statustext
Gendertext
Blood grouptext
Emergency contactstext
Social profilestext
Addressobject
Streettext
Citytext
Statetext
Country codetext
Zip codetext
Phone numberstext
Communication addressobject
Communication streettext
Communication citytext
Communication statetext
Communication country codetext
Communication zip codetext
Same as residentialboolean
Designationtext
36other output fields
Create an ApplicantAction
Input fields[3]
FieldType
Job Post IDRequired
choice
First NameRequired
text
Middle Nametext
Last NameRequired
text
EmailRequired
email
Mobiletext
Phonetext
Owner IDRequired
choice
Source IDRequired
choice
Source Category IDRequired
choice
Genderchoice
Custom Fieldsobject
Candidate IDtext
Output fields[3]
FieldType
IDnumber
Created atdate
Updated atdate
Deletedboolean
Statustext
Job IDnumber
Requisition IDnumber
Custom fieldsobject
Cf custom exampletext
Stage IDnumber
Candidateobject
IDnumber
Eeo veterantext
Eeo ethnicitytext
Eeo disabledtext
Eeo gendertext
First nametext
Middle nametext
Last nametext
Emailtext
Source IDnumber
Create an EmployeeAction
Input fields[3]
FieldType
First NameRequired
text
Last NameRequired
text
Official EmailRequired
email
Employee Typechoice
Role IDsRequired
array
Role IDnumber
Employee IDtext
Middle Nametext
Personal Emailemail
Work Numbersarray
Phone Numbersarray
Date of Birthdate
Designationtext
Joining Datedate
Branch IDnumber
HR Incharge IDnumber
Reporting To IDnumber
Business Unit IDnumber
Sub Department IDnumber
Shift IDnumber
Department IDnumber
11other input fields
Output fields[3]
FieldType
Employee IDnumber
Created atdate
Updated atdate
Deletedboolean
Work numbersarray
Nick nametext
Date of birthtext
Gendertext
Addressobject
Streettext
Statetext
Citytext
Country codetext
Zip codetext
Phone numbersarray
Communication addressobject
Same as residentialboolean
Communication streettext
Communication statetext
Communication citytext
Communication country codetext
Communication zip codetext
Designationtext
Joining datetext
Branch IDnumber
Team IDnumber
Business unit IDnumber
Sub department IDtext
Department IDtext
Reporting to IDtext
Hr incharge IDtext
10other output fields
Create Time Off RequestAction
Input fields[3]
FieldType
User IDRequired
choice
Start DateRequired
date
End DateRequired
date
Leave Type IDRequired
choice
Statuschoice
Leave Unitsnumber
Optional Leave Unitsnumber
Status Commentstext
Approved By IDchoice
Applied By IDchoice
Cancelled By IDchoice
Rejected By IDchoice
Commentstext
Rejected Atdate
Cancelled Atdate
Output fields[3]
FieldType
Time Off IDnumber
Created atdate
Updated atdate
Deletedboolean
Nametext
Descriptiontext
Applicable fortext
Defaultboolean
Auto approveboolean
Auto approve aftertext
Auto approve limittext
Marital statustext
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
Send Employee Portal Invitation EmailAction
Input fields[3]
FieldType
Employee IDRequired
choice
Send Invite EmailRequired
boolean
Update a New HireAction
Input fields[3]
FieldType
Hire IDRequired
text
Employee IDRequired
choice
First Nametext
Last Nametext
StatusRequired
choice
Official Emailemail
Personal Emailemail
Employee Typechoice
Work Numbersarray
Date of Birthdate
Genderchoice
Blood Groupchoice
Addressobject
Streettext
Citytext
Statetext
Country Codetext
ZIP Codetext
Communication Addressobject
Communication Streettext
Communication Citytext
Communication Statetext
Communication Country Codetext
Communication ZIP Codetext
Same as Residentialboolean
Designationtext
Joining Datedate
Branch IDchoice
Team IDchoice
Business Unit IDchoice
Sub Department IDchoice
7other input fields
Update a Time Off RequestAction
Input fields[3]
FieldType
Time off IDchoice
Statuschoice
Approved By IDchoice
Commentstext
Output fields[3]
FieldType
Time Off IDnumber
Created atdate
Updated atdate
Deletedboolean
Nametext
Descriptiontext
Applicable fortext
Defaultboolean
Auto approveboolean
Auto approve aftertext
Auto approve limittext
Marital statustext
Update a Time Off RequestAction
Input fields[3]
FieldType
Tim off IDchoice
Statuschoice
Cancelled By IDchoice
Rejected By IDchoice
Commentstext
Rejected Atdate
Cancelled Atdate
Output fields[3]
FieldType
Time Off IDnumber
Created atdate
Updated atdate
User IDnumber
Start datedate
End datedate
Statustext
Leave unitsnumber
Optional leave unitstext
Leave type IDnumber
Status commentstext
Approved by IDtext
Applied by IDnumber
Cancelled by IDtext
Rejected by IDtext
Commentstext
Rejected attext
Cancelled attext
Update an EmployeeAction
Input fields[3]
FieldType
Employee IDRequired
choice
First Nametext
Last Nametext
Official EmailRequired
email
Employee Typechoice
Role IDsarray
Role IDnumber
Employee IDtext
Middle Nametext
Personal Emailemail
Work Numbersarray
Phone Numbersarray
Date of Birthdate
Designationtext
Joining Datedate
Branch IDnumber
HR Incharge IDnumber
Reporting To IDnumber
Business Unit IDnumber
Sub Department IDnumber
Shift IDnumber
12other input fields
Output fields[3]
FieldType
Employee IDnumber
Created atdate
Updated atdate
Deletedboolean
Work numbersarray
Nick nametext
Date of birthtext
Gendertext
Addressobject
Streettext
Statetext
Citytext
Country codetext
Zip codetext
Phone numbersarray
Communication addressobject
Same as residentialboolean
Communication streettext
Communication statetext
Communication citytext
Communication country codetext
Communication zip codetext
Designationtext
Joining datetext
Branch IDnumber
Team IDnumber
Business unit IDnumber
Sub department IDtext
Department IDtext
Reporting to IDtext
Hr incharge IDtext
10other output fields

Look for FreshTeam templates in the WEXTL template library.

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

Last updated: Jul 24, 2026 18:11