Freshteam API Integration

These are the list of integration use cases supported by Knit for Freshteam API as part of the HRIS category

List All Candidate Source Categories

ID: get_candidate_source_categories
Operation: read
Entities: candidate, source category
Summary: This API retrieves a list of all candidate source categories configured in the Freshteam system. It requires an authorization bearer token and expects the response in JSON format. The response includes an array of source category objects, each containing details such as id, creation and update timestamps, deletion status, label, default status, and the number of leads associated with the category.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Employee Information

ID: get_employee_information
Operation: read
Entities: compensation detail, employee, department
Summary: The Retrieve Employee Information API identifies an employee by the id passed in the request and returns the corresponding information as an employee object. The API uses the GET method and requires the employee's id as a path parameter. Optional query parameters can be used to include additional attributes in the response, such as compensation details, time off, and more. The request must include headers for 'accept' and 'Authorization'. A successful request returns a 200 OK status with the employee object in the response body, which includes detailed information such as personal details, employment status, contact information, and team details.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Job Posting Information

ID: get_job_posting_information
Operation: read
Entities: job posting, requisition, employee
Summary: The Retrieve Job Posting Information API identifies a job posting by the provided ID and returns the corresponding information as a job posting object. The API requires an 'id' path parameter which is the identifier of the job posting object. The request must include headers for 'accept' and 'Authorization'. The response includes details such as the applicant apply link, custom field values, skills, remote branches, and requisitions associated with the job posting.
Input Fields: Input Fields
Output Fields: Output Fields

List All Applicant Fields

ID: get_list_all_applicant_fields
Operation: read
Entities: applicant form, applicant field, job posting
Summary: The 'List All Applicant Fields' API allows an organization to retrieve details of all applicant fields associated with a specific job posting. By providing the job posting ID as a path parameter, the API returns an array of applicant field objects. Each object contains detailed information about the field, including its ID, creation and update timestamps, field type, label, position, and various boolean flags indicating its default status and inclusion in different forms. The API also provides details about view permissions and picklist values for dropdown or radio fields. This API is useful for organizations to manage and review the custom applicant forms attached to their job postings.
Input Fields: Input Fields
Output Fields: Output Fields

List All Branches

ID: get_list_all_branches
Operation: read
Entities: organization, branch
Summary: The 'List All Branches' API retrieves a list of all branches configured for an organization using Freshteam. It requires an HTTP GET request to the endpoint '/api/branches' with headers specifying the accepted response format and an authorization bearer token. The response includes an array of branch objects, each containing details such as the branch ID, creation and update timestamps, name, location details (city, state, country code, zip), time zone, currency, language, and whether it is the main office. The response is paginated, and pagination details are included in the response headers.
Input Fields: Input Fields
Output Fields: Output Fields

List All Business Units

ID: get_list_all_business_units
Operation: read
Entities: business unit
Summary: This API retrieves a list of all business units configured in the Freshteam system. It requires an authorization bearer token and accepts JSON format for the response. The response includes an array of business unit objects, each containing details such as id, creation and update timestamps, deletion status, name, and description. The response is paginated, and pagination details are included in the response headers.
Input Fields: Input Fields
Output Fields: Output Fields

List All Candidate Source Categories

ID: get_list_all_candidate_source_categories
Operation: read
Entities: candidate, source category
Summary: This API retrieves a list of all candidate source categories configured in the Freshteam system. It requires an authorization bearer token and accepts JSON format for the response. The response includes an array of source category objects, each containing details such as id, creation and update timestamps, deletion status, label, default status, and the number of leads associated with the category.
Input Fields: Input Fields
Output Fields: Output Fields

List All Candidate Sources

ID: get_list_all_candidate_sources
Operation: read
Entities: source, candidate
Summary: The 'List All Candidate Sources' API retrieves a list of all candidate sources configured in the Freshteam system. It uses the GET HTTP method and requires an authorization bearer token in the request headers. The API endpoint is '/api/candidate_sources'. The response is a JSON array containing details of each source, including attributes such as 'id', 'created_at', 'updated_at', 'deleted', 'label', 'default', and 'leads_count'.
Input Fields: Input Fields
Output Fields: Output Fields

List All Departments

ID: get_list_all_departments
Operation: read
Entities: organization, department
Summary: The 'List All Departments' API retrieves a list of all departments within an organization. It uses the GET method and requires an authorization bearer token in the request headers. The endpoint is '/api/departments' and returns a JSON array of department objects, each containing details such as 'id', 'created_at', 'updated_at', 'deleted', and 'name'. The response is paginated, and pagination details are included in the response headers.
Input Fields: Input Fields
Output Fields: Output Fields

List All Employee Fields

ID: get_list_all_employee_fields
Operation: read
Entities: organization, employee, employee field
Summary: The 'List All Employee Fields' API retrieves a list of all default and custom employee fields configured for an organization in the Freshteam system. It uses the GET method and requires an authorization bearer token in the request headers. The API endpoint is '/api/employee_fields'. The response includes an array of employee field objects, each containing details such as 'id', 'name', 'label', 'field_type', and more. The response is paginated, and pagination details are included in the response headers.
Input Fields: Input Fields
Output Fields: Output Fields

List All Employees

ID: get_list_all_employees
Operation: read
Entities: employee, department, business unit
Summary: The 'List All Employees' API retrieves a list of all employees whose details are configured in the Freshteam system. It uses the GET method and the endpoint is '/api/employees'. The API supports various query parameters to filter and sort the employee data, such as 'status', 'first_name', 'last_name', 'personal_email', 'official_email', 'employee_type', 'department', 'business_unit', 'location', 'reporting_manager', 'updated_since', 'sort', 'sort_type', 'draft', 'terminated', 'deleted', and 'page'. The 'page' parameter specifies the page number starting from which the response data is retrieved, with a default value of 1. The response includes an array of employee objects, each containing details like 'id', 'created_at', 'updated_at', 'deleted', 'work_numbers', 'nick_name', 'date_of_birth', 'gender', 'address', 'phone_numbers', 'communication_address', 'designation', 'joining_date', 'branch_id', 'team_id', 'business_unit_id', 'sub_department_id', 'department_id', 'reporting_to_id', 'hr_incharge_id', 'shift_id', 'termination_date', 'first_name', 'middle_name', 'last_name', 'employee_id', 'status', 'official_email', 'personal_email', and 'employee_type'. The response headers also include 'total-objects', 'total-pages', and 'link' which provide information on the number of objects returned, the number of pages, and the URL to the next page if available.
Input Fields: Input Fields
Output Fields: Output Fields

List All Job Posting Fields

ID: get_list_all_job_posting_fields
Operation: read
Entities: job form, picklist value, job posting field
Summary: This API retrieves a list of all default and custom job posting fields configured for an organization in the Freshteam system. It uses the GET method and requires an authorization bearer token in the request headers. The response includes an array of job posting field objects, each containing attributes such as id, created_at, updated_at, job_form_id, name, label, field_type, position, required, default, public, restricted, and picklist_values. These attributes provide detailed information about each job posting field, including its type, position, and visibility settings.
Input Fields: Input Fields
Output Fields: Output Fields

List All Job Postings

ID: get_list_all_job_postings
Operation: read
Entities: job posting, branch, department
Summary: The 'List All Job Postings' API retrieves a list of all job postings configured in the Freshteam system. It uses the GET method and the endpoint is '/api/job_postings'. The API supports various query parameters to filter the job postings, such as 'status', 'title', 'type', 'department', 'location', 'remote', 'location_city', and 'location_country'. The request requires headers for 'accept' and 'Authorization'. The response includes an array of job posting objects, each containing details like 'id', 'title', 'description', 'status', 'salary', 'remote', 'branch', and 'department'. The response headers also include pagination details.
Input Fields: Input Fields
Output Fields: Output Fields

List All Levels

ID: get_list_all_levels
Operation: read
Entities: level, organization
Summary: The 'List All Levels' API retrieves a list of all levels configured for an organization using Freshteam. It requires a GET request to the endpoint '/api/levels' with headers specifying the response format as 'application/json' and an authorization bearer token. The response includes an array of level objects, each containing details such as 'id', 'created_at', 'updated_at', 'deleted', and 'name'. The response is paginated, and pagination details are included in the response headers.
Input Fields: Input Fields
Output Fields: Output Fields

List All Roles

ID: get_list_all_roles
Operation: read
Entities: organization, role, account
Summary: The 'List All Roles' API retrieves a list of all valid roles for the organization using Freshteam. It requires a GET request to the endpoint '/api/roles' with headers specifying 'accept' as 'application/json' and an 'Authorization' bearer token. The response includes an array of role objects, each containing details such as 'id', 'created_at', 'updated_at', 'name', 'description', and 'default' status. The response is paginated, and pagination details are included in the response headers.
Input Fields: Input Fields
Output Fields: Output Fields

List All Sub-Departments

ID: get_list_all_sub_departments
Operation: read
Entities: sub-department, department
Summary: The 'List All Sub-Departments' API retrieves a list of all sub-departments within a department. It requires an authorization token and specifies the response format in the headers. The response includes an array of sub-department objects, each containing details such as id, creation and update timestamps, deletion status, and name. Pagination details are included in the response headers.
Input Fields: Input Fields
Output Fields: Output Fields

List All Teams

ID: get_list_all_teams
Operation: read
Entities: organization, team, employee
Summary: The 'List All Teams' API retrieves a list of all employee teams configured for an organization using Freshteam. It requires a GET request to the endpoint '/api/teams' with headers specifying the accepted response format and an authorization bearer token. The response includes an array of team objects, each containing details such as the team's ID, creation and update timestamps, deletion status, and name. The response is paginated, and pagination details are included in the response headers.
Input Fields: Input Fields
Output Fields: Output Fields

List All Timeoff Types

ID: get_list_all_timeoff_types
Operation: read
Entities: organization, vacation type, timeoff type
Summary: The 'List All Timeoff Types' API retrieves a list of all vacation types configured for an organization. It uses the GET method and requires an authorization bearer token in the headers. The endpoint is '/api/time_off_types'. The response includes an array of timeoff type objects, each containing attributes such as 'id', 'name', 'description', and 'default'. The response is paginated, and pagination details are included in the response headers.
Input Fields: Input Fields
Output Fields: Output Fields

List All Timeoffs

ID: get_list_all_timeoffs
Operation: read
Entities: time_off, employee, leave_type
Summary: The 'List All Timeoffs' API retrieves a list of all time-off requests from all employees in the organization. It uses the GET method and the endpoint '/api/time_offs'. The API supports various query parameters to filter the results, including 'status', 'user', 'leave_type', 'location', 'start_date', and 'end_date'. The request requires headers for 'accept' and 'Authorization'. The response includes an array of time-off objects, each containing details such as 'id', 'user_id', 'start_date', 'end_date', 'status', and more. The response headers also include pagination details.
Input Fields: Input Fields
Output Fields: Output Fields

List all user functions

ID: get_list_all_user_functions
Operation: read
Entities: user function
Summary: The 'List all user functions' API retrieves a list of all user functions configured in the Freshteam system. It requires a GET request to the endpoint '/api/user_functions' with headers specifying 'accept' as 'application/json' and an 'Authorization' bearer token. The response is a JSON array containing user function objects, each with attributes such as 'id', 'created_at', 'updated_at', 'value', and 'position'.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve New Hire Information

ID: get_new_hire_information
Operation: read
Entities: new hire, department, award
Summary: The Retrieve New Hire Information API identifies a new hire by the id passed in the request and returns the corresponding information as a new hire object. The API uses the GET method and requires the 'id' path parameter, which is the auto-generated identifier for the new hire in the Freshteam system. Optional query parameters can be used to include additional attributes in the response, such as branch, team, and other details. The request must include headers for 'accept' and 'Authorization' with a Bearer token. A successful request returns a 200 OK status with the new hire object in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Timeoff Information

ID: get_timeoff_information
Operation: read
Entities: id, timeoff, request
Summary: The Retrieve Timeoff Information API identifies a time-off request by the ID passed in the request and returns the corresponding information as a timeoff object. The API uses the GET method and requires the 'id' path parameter, which is an integer identifier of the timeoff object. The request headers must include 'accept' set to 'application/json' and an 'Authorization' bearer token. A successful request returns a 200 OK status along with the retrieved timeoff object in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Create an Applicant for a Job Posting

ID: post_create_applicant
Operation: write
Entities: job posting, candidate, applicant
Summary: The 'Create an Applicant for a Job Posting' API allows users to create an applicant for a specific job posting in the Freshteam system. The API requires the job posting ID as a path parameter and accepts applicant details in the request body. The request body must include mandatory fields such as first name, last name, email, source ID, and source category ID. Optional fields include middle name, mobile, phone, gender, profile links, location, skype ID, resumes, cover letters, and portfolios. The API also supports custom fields for additional applicant information. The response includes the applicant's ID, creation and update timestamps, status, job ID, requisition ID, custom fields, stage ID, and candidate details. The API uses multipart/form-data for requests with attachments and requires authorization via a Bearer token.
Input Fields: Input Fields
Output Fields: Output Fields

Create Candidate Source

ID: post_create_candidate_source
Operation: write
Entities: source, leads_count, label
Summary: The Create Candidate Source API allows users to create a new candidate source by providing a label in the request body. The request must include headers for content type, authorization, and accept type. The label is a mandatory field with a minimum length of 2 characters and a maximum length of 128 characters. Upon successful creation, the API returns a 201 status code along with the details of the newly created source, including its id, creation and update timestamps, deletion status, label, default status, and leads count.
Input Fields: Input Fields
Output Fields: Output Fields

Create Custom Employee Field

ID: post_create_custom_employee_field
Operation: write
Entities: section, employee form, employee field
Summary: This API creates a custom employee field in an employee form. It requires a POST request to the endpoint /api/employee_fields with a JSON body containing the field details. The request body must include 'label' (display name of the custom field) and 'section_name' (namespace identifier of the section) as mandatory fields. The 'required' field specifies if the custom field is mandatory, and 'field_type' specifies the type of the field (text or number). A successful request returns a 201 Created status with the created employee field object, including attributes like id, created_at, updated_at, and section_label.
Input Fields: Input Fields
Output Fields: Output Fields

Create an Employee

ID: post_create_employee
Operation: write
Entities: role, employee, department
Summary: This API creates an employee object based on the information specified in the request body. The request body must be a valid JSON object containing details such as first name, last name, official email, and role IDs, among other optional attributes like middle name, personal email, and address. The API requires headers for authorization and content type. A successful request returns a 201 Created status along with the created employee object, which includes the employee's unique ID, creation timestamp, and last updated timestamp.
Input Fields: Input Fields
Output Fields: Output Fields

Create a New Hire

ID: post_create_new_hire
Operation: write
Entities: address, hire, employee
Summary: The 'Create a New Hire' API allows you to create a new hire object by providing detailed information about the new hire in the request body. The request must include mandatory fields such as 'first_name', 'last_name', 'personal_email', and 'joining_date'. Optional fields include 'middle_name', 'official_email', 'employee_id', and more. The API returns a 201 Created status with the new hire object, including 'id', 'created_at', and 'updated_at' attributes, which can be used for further operations like updating or retrieving the new hire information.
Input Fields: Input Fields
Output Fields: Output Fields

Create Timeoff Request

ID: post_create_timeoff_request
Operation: write
Entities: response, timeoff, request body
Summary: The Create Timeoff Request API allows users to create a timeoff object by sending a POST request to the specified endpoint. The request must include headers for content type and authorization, and a request body containing details such as start and end dates, optional leave days, notification list, calendar addition preference, auto-decline events preference, leave type ID, and comments. A successful request returns a 201 Created status along with the created timeoff object, which includes the id, created_at, and updated_at attributes.
Input Fields: Input Fields
Output Fields: Output Fields

Approve a Timeoff Request

ID: put_approve_timeoff_request
Operation: write
Entities: leave type, timeoff, user
Summary: This API approves a time-off request by updating the status of the time-off object identified by the provided ID to 'approved'. The request requires the path parameter 'id' which is the identifier of the time-off object. The request headers must include 'accept', 'Authorization', and 'Content-Type'. The request body should be an empty JSON object. Upon successful approval, the API returns a 200 OK status along with the updated time-off object details, including the status, leave type, and user information.
Input Fields: Input Fields
Output Fields: Output Fields

Cancel a Timeoff Request

ID: put_cancel_timeoff_request
Operation: write
Entities: time off, leave type, user
Summary: This API cancels a time-off request by identifying the time-off object using the provided ID in the path parameter. The request is made using the PUT method to the endpoint '/api/time_offs/{id}/cancel'. The request headers must include 'accept', 'Authorization', and 'Content-Type'. The path parameter 'id' is mandatory and should be an integer representing the time-off object. The request body should be an empty JSON object. A successful request returns a 200 OK status with the updated time-off object, where the status is changed to 'cancelled'. The response includes detailed information about the time-off request, such as 'id', 'created_at', 'updated_at', 'user_id', 'start_date', 'end_date', 'status', and other related attributes.
Input Fields: Input Fields
Output Fields: Output Fields

Send Employee Portal Invitation Email

ID: put_send_employee_portal_invitation_email
Operation: write
Entities: employee portal, invitation email, employee
Summary: The Send Employee Portal Invitation Email API is used to send an invitation email to an employee's official email address for activating their access to the employee portal. The API requires the employee's unique ID as a path parameter and a boolean in the request body to specify sending the invite. Upon successful execution, it returns a 200 OK status along with the updated employee object.
Input Fields: Input Fields
Output Fields: Output Fields

Update Employee Information

ID: put_update_employee_information
Operation: write
Entities: employee, information, request
Summary: The Update Employee Information API allows you to update the details of an existing employee in the Freshteam system. You need to provide the employee's unique ID in the path parameters and the updated information in the request body. The request must include headers for content type and authorization. The response returns the updated employee object if the request is successful. The request body can include various fields such as first name, last name, official email, role IDs, employee ID, personal email, work numbers, phone numbers, date of birth, designation, joining date, branch ID, HR in-charge ID, reporting to ID, business unit ID, sub-department ID, shift ID, department ID, team ID, level ID, blood group, gender, address, communication address, custom fields, draft status, cost center ID, ID card details, and whether to send an invite email.
Input Fields: Input Fields
Output Fields: Output Fields

Update New Hire Information

ID: put_update_new_hire_information
Operation: write
Entities: new hire
Summary: The 'Update New Hire Information' API allows you to update the details of a new hire identified by their unique ID. The API endpoint requires the ID of the new hire as a path parameter. The request must include headers for 'accept', 'Authorization', and 'Content-Type'. The request body can include optional fields such as 'first_name', 'last_name', 'personal_email', and 'joining_date'. If any of these fields are not provided or are null, their existing values will be retained. A successful request returns a 200 OK status along with the updated new hire object.
Input Fields: Input Fields
Output Fields: Output Fields