← Tools Reference

Freshteam

Freshteam integration (Productivity, Data). Imported from open-connector.

API key9 toolshttps://{domain}.freshteam.com
GET
freshteam_list_employees
List Freshteam employees with optional directory filters and pagination.

/api/employees

17 parameters
ParamTypeRequiredDescription
pageintegeroptionalPage number for the Freshteam list request.
statusstringoptionalFreshteam employee status filter.
firstNamestringoptionalFirst name used to filter Freshteam employees.
lastNamestringoptionalLast name used to filter Freshteam employees.
personalEmailstringoptionalPersonal email address used to filter Freshteam employees.
officialEmailstringoptionalOfficial email address used to filter Freshteam employees.
employeeTypestringoptionalFreshteam employee type filter.
departmentIdintegeroptionalFreshteam department identifier filter.
businessUnitIdintegeroptionalFreshteam business unit identifier filter.
locationIdsarrayoptionalFreshteam location identifiers used to filter employee results.
reportingManagerIdintegeroptionalFreshteam employee identifier for the reporting manager filter.
updatedSincestringoptionalISO 8601 timestamp used as Freshteam's updated_since filter.
sortstringoptionalFreshteam employee field used for sorting results.
sortTypestringoptionalFreshteam sort direction.
draftbooleanoptionalWhether to return Freshteam draft employees.
terminatedbooleanoptionalWhether to return Freshteam terminated employees.
deletedbooleanoptionalWhether to return Freshteam deleted employees.
GET
freshteam_get_employee
Get one Freshteam employee by identifier.

/api/employees/{employeeId}

2 parameters
ParamTypeRequiredDescription
employeeIdintegerrequiredFreshteam employee identifier.
includearrayoptionalFreshteam include tokens for employee details.
GET
freshteam_list_employee_fields
List Freshteam employee form fields.

/api/employee_fields

1 parameter
ParamTypeRequiredDescription
pageintegeroptionalPage number for the Freshteam list request.
GET
freshteam_list_job_postings
List Freshteam job postings with optional recruiting filters.

/api/job_postings

9 parameters
ParamTypeRequiredDescription
pageintegeroptionalPage number for the Freshteam list request.
statusstringoptionalFreshteam job posting status filter.
titlestringoptionalFreshteam job posting title filter.
typestringoptionalFreshteam job posting type filter.
departmentIdintegeroptionalFreshteam department identifier filter.
locationIdintegeroptionalFreshteam location identifier filter.
remotebooleanoptionalWhether to filter Freshteam job postings by remote status.
locationCitystringoptionalFreshteam job posting city filter.
locationCountrystringoptionalFreshteam job posting country code filter.
GET
freshteam_get_job_posting
Get one Freshteam job posting by identifier.

/api/job_postings/{jobPostingId}

1 parameter
ParamTypeRequiredDescription
jobPostingIdintegerrequiredFreshteam job posting identifier.
GET
freshteam_list_job_posting_fields
List Freshteam job posting fields.

/api/job_posting_fields

1 parameter
ParamTypeRequiredDescription
pageintegeroptionalPage number for the Freshteam list request.
GET
freshteam_list_applicant_fields
List Freshteam applicant fields for one job posting.

/api/job_postings/{jobPostingId}/applicant_fields

2 parameters
ParamTypeRequiredDescription
jobPostingIdintegerrequiredFreshteam job posting identifier.
pageintegeroptionalPage number for the Freshteam list request.
GET
freshteam_list_candidate_sources
List Freshteam candidate sources.

/api/candidate_sources

1 parameter
ParamTypeRequiredDescription
pageintegeroptionalPage number for the Freshteam list request.
GET
freshteam_list_candidate_source_categories
List Freshteam candidate source categories.

/api/candidate_source_categories

1 parameter
ParamTypeRequiredDescription
pageintegeroptionalPage number for the Freshteam list request.