A Guide toIntegrating with Freshteams API

Freshteam API Directory

A cloud based HR software, Freshteam enables organizations with managing employee details, recruitment, on-boarding, time-off, off-boarding, and organization details, among other aspects of their HR processes and practices. With Freshteam API integration, organizations can seamlessly synchronize data between their application and Freshteam to ensure real time updation of employee information across both platforms. It helps capture any changes in employee status, designation, HR policies, etc. across different applications a business uses. 

Freshteam API Authentication, Filtering, Rate Limits

To ensure utmost security and prevent unauthorized access, Freshteam API uses Oauth2.0 for authentication and authorization. Developers can use the Freshteam UI to make calls to the Freshteam authentication server to obtain an access token. This access token can be used to make valid API calls thereon. The access token identifies the requester and the requester’s permission. In the Freshteam domain, the access token is present under Your API Key, which can be copied and used to make API calls. 

‍

Rate limits i.e. the number of API calls that can be made in a minute for Fresteam API are determined by the plan selected by the organization. The rate limit variation for each plan is dependent on the number of subscribed employees for the organization. The trial account has a limit of 10 API calls per minute, which goes on to as high as (100, 2 * number of subscribed employees) API calls per minute for the enterprise plan. Developers or admins can also keep a track of the API calls to understand their usage patterns via:

‍

• X-ratelimit-total: Permissible number of API calls in a minute.
• X-ratelimit-remaining: Number of API calls remaining.
• X-ratelimit-used-currentrequest: Number of API calls consumed by the API request that obtained the response.

‍

There are several endpoints in Freshteam API which retrieve bulk data, especially the ones which are required to List a certain object. In such a case, developers can use pagination parameters to filter data and limit the responses for a streamlined understanding. Developers can select the page value (from which page number they want responses), as well as the number of responses required for each page (default is set at 50). They can also sort the values as ascending or descending or select some other attribute for sorting as well. 

Freshteam API Objects, Data Models & Endpoints

Employees

• List all employees: GET /employees
• Create an employee: POST /employees
• Retrieve employee information: GET /employees/{id}
• Update employee information: PUT /employees/{id}
• List all employee fields: GET /employee_fields
• Create a custom employee field: POST /employee_fields

‍

Common attributes: id, created at, updated at, workstation number, date of birth, gender, address, communication address, designation, phone number, joining date, termination date, first name, last name, status, official email, personal email, employee type, team id, department id, reporting to id, time off, hire reason, marital status, etc. 

Branches

(Used to configure different geographical locations for an organization and associate employees to a branch)

‍

• List all branches: GET /branches

‍

Common attributes: id, created at, updated at, name, street, state, country code, zip, time zone, currency, language, main office, date format

Departments & Sub-Departments

• List all departments: GET /departments
• List all sub-departments: GET /sub_departments

Business Units

• List all business units: GET /business_units

‍

Common attributes: id, created at, updated at, name, description

Teams

• List all teams: GET /teams

Levels

• List all levels: GET /levels

Timeoffs

• List all timeoffs: GET /time_offs
• Create a timeoff request: POST /time_offs
• List all timeoff types: GET /time_off_types
• Retrieve timeoff information: GET /time_off_types/{id}
• Cancel A Timeoff Request: PUT /time_off_types/{id}/ cancel
• Approve A Timeoff Request: PUT /time_off_types/{id}/ approve

‍

Common attributes: id, created at, updated at, start date, end date, status, leave units, leave type id, status comments, comments, attachment, applied by, approved by, rejected by, canceled by, notify to, description, add to calendar, canceled at, optional leave days, applicable for, auto approve, status

Roles

• List all roles: GET /roles

Job Postings

• List all job postings: GET /job_postings
• Retrieve job posting information: GET /job_postings/{id}
• List all job posting fields: GET /job_posting_fields
• List all applicant fields: GET /job_postings/{id}/applicant_fields
• Create an applicant: POST  /job_postings/{id}/applicants

‍

Common attributes: id, created at, updated at, deleted, title, description, status, show_pursue_as_career, closing date, experience, remote, type, salary, branch, department, title, location, skills, requisitions, label, field type, position, candidate, candidate id, first name, last name, date of birth, mobile, phone number, source id, resume, cover letter, portfolio, skype id, content file name, url, gender, profile link, rejected at, archived at, on hold at, on hold till

Candidate Sources

• List all candidate sources: GET /candidate_sources
• Create a candidate source: POST /candidate_sources
• List all candidate source categories: GET ​/candidate_source_categories

‍

Common attributes: id, created at, updated at, deleted, label, default, leads count

User Functions

• List all user functions: GET /user_functions

New Hires

• Create a new hire: POST /new_hires
• Retrieve new hire information: GET /new_hires/{id}
• Update new hire information: PUT /new_hires/{id}

‍

Common attributes: id, created at, updated at, deleted, first name, middle name, last name, official email, employee id, status, workstation number, designation, joining date, probation start date, probation end date, branch id, team id, department id, sub department id, termination date, termination reason, notice period, notice start date, notice end date, employee type, hired on, no show, no show reason, date of birth, marital status, gender, blood group, emergency contacts, social profiles, address, communication address, phone numbers, job codes, job exempt, scheduled weekly hours, retirement eligibility date, rehire eligibility, rehire status, confirmed, language, branch, team

Freshteam API Use Cases

• Centralize HR operations with AI-powered virtual agents, self-service solutions and  seamless integration with MS Teams, Slack, and other applications
• Automate internal processes with easy-to-configure workflows, leading to streamlined work and increased efficiency
• Leverage 50+ job descriptions out of the box for use to accelerate hiring processes
• Capture qualitative feedback about candidates along with better candidate relationships through built-in email and a manageable candidate database

Top customers

50,000+ companies from across 120+ countries use Freshteam to power their HR operations and streamline processes to make them efficient, robust and optimized. Here are some of the top customers that are leveraging Freshteam:

‍

• Gartner, Inc., an American technological research and consulting firm
• OpeninApp, a smart link generator tool that ensures all social media links open in the apps they should
• Dymocks Booksellers, an Australian-founded privately owned bookstore chain
• Valley Medical Center, a 321-bed, acute care community hospital and clinic network
• Kirat Plastics, a full-service custom plastic injection molding, metal pressing, fabrication, and assembly facility
• Lot Squared Development, a Washington DC based design-build residential real estate developer 

Freshteam API FAQs

Here is a list of Freshteam API FAQs that developers must understand to make their integration journey more effective and robust:

‍

• How to use Freshteam Developer API? Answer
• Where to find Freshteam API key, how to reset it and Scope of an API Key? Answer
• What are the status and error messages that indicate the success or failure of an API request in Freshteam API? Answer
• What are the common request header parameters used in requests to Freshteam APIs? Answer
• What are the API methods that developers interact with for Freshteam API? Answer
• What are models in Freshteam API? Answer

Common Integrations with Freshteam API 

Businesses, especially those engaged in the employee side of work, are increasingly seeking integration with Freshteam API to streamline data exchange between this HRIS platform and their application. Some of the top use cases and common integrations with Freshteam API include:

‍

• Recruitment companies which can use the write APIs to update candidate information into Freshteam once a client is hired to ensure the customer’s HRIS is up to date for all onboarding and future requirements
• Payroll providers can leverage both read APIs to fetch employee information for payroll creation and disbursement, as well as write APIs, to push back data into customer’s Freshteam account to notify that salaries have been paid
• Rewards and recognition companies which can use integration with Freshteam API to fetch information on employees to seamlessly manage their operations and help end customers build a culture of recognition.  

How to integrate with Freshteam API 

To kickstart the integration journey with Freshteam API, developers can go through this quick start guide. The first step is to create a developer account and join the Freshteam developer community. Next developers need to follow the installation instructions to install the API SDK. Following this it is important to get acquainted with the authorization and authentication protocols to access data and make API calls.  Learn about the terms of use for accessing or using the Freshteam developer portal and understand the different terminology used. For more support and information, businesses can scroll through the Freshteam support page and get answers to their queries. 

Get started with Freshteam API 

Companies that integrate with Freshteam API benefit from the seamless exchange of information between this HRIS platform and their application and have been able to explore multiple use cases for their end customers. However, manually building and maintaining integration with Freshteam API can be a daunting task for developers. Building the integration alone can take 4 weeks on an average and cost USD 10K (considering the cost of software developers, QA engineers, etc.). Further, the cost associated with maintaining the Freshteam API adds another burden on the bottom line, while diverting resources away from core product functionalities and enhancements. And, this is for a single HRIS integration in question here (Freshteam API). Businesses generally need to integrate with multiple HRIS APIs, meeting the demands of their end customers. Here, a unified HRIS API like Knit can enable businesses to easily integrate with multiple HRIS applications with a single connector. By incorporating an additional layer of abstraction, a unified API allows businesses to ship and scale integrations faster and in an efficient manner. Book a discovery call today to learn how developers can integrate with Freshteam API and other HRIS applications within hours and not weeks. 

‍