Freshteams API Directory

Freshteam is a comprehensive HR software solution designed to streamline recruitment, onboarding, and employee management processes. As part of the Freshworks suite, Freshteam offers a user-friendly interface that simplifies the complexities of human resource management, making it an essential tool for businesses of all sizes. By automating repetitive tasks and providing a centralized platform for managing employee data, Freshteam enhances efficiency and productivity within HR departments.

One of the standout features of Freshteam is its robust API integration capabilities. The Freshteams API allows businesses to seamlessly connect Freshteam with other software applications, facilitating data exchange and enhancing workflow automation. This integration capability is crucial for organizations looking to create a cohesive HR ecosystem, enabling them to leverage the full potential of Freshteam alongside their existing tools. By utilizing the Freshteams API, companies can customize their HR processes to better suit their unique needs, ensuring a more tailored and efficient approach to human resource management.

Key highlights of freshteam APIs

  • Easy Data Access:
    • Access employee information effortlessly with Freshteam API's streamlined data retrieval capabilities.
  • Automation:
    • Enhance efficiency through seamless data synchronization and automated HR processes.
  • Custom Integration:
    • Integrate with various platforms using a unified API for multiple integrations, tailored to your business needs.
  • Real-Time Sync:
    • Keep your data up-to-date with real-time updates, ensuring accuracy across all systems.
  • Developer-Friendly:
    • Benefit from an accessible API design, SDKs, and comprehensive documentation for easy implementation.

Employee Management

  • put /api/employees/{id}/send_invite : Send Employee Portal Invitation Email
  • get https://<account-name>.freshteam.com/api/employees : List All Employees
  • put https://<account-name>.freshteam.com/api/employees/{id} : Update Employee Information
  • post https://<account-name>.freshteam.com/api/employee_fields : Create Custom Employee Field
  • post https://<account-name>.freshteam.com/api/new_hires : Create a New Hire
  • put https://<account-name>.freshteam.com/api/new_hires/{id} : Update New Hire Information

Organizational Structure

  • get https://<account-name>.freshteam.com/api/branches : List All Branches
  • get https://<account-name>.freshteam.com/api/business_units : List All Business Units
  • get https://<account-name>.freshteam.com/api/departments : List All Departments
  • get https://<account-name>.freshteam.com/api/sub_departments : List All Sub-Departments
  • get https://<account-name>.freshteam.com/api/teams : List All Teams
  • get https://<account-name>.freshteam.com/api/roles : List All Roles
  • get https://<account-name>.freshteam.com/api/levels : List All Levels

Recruitment

  • get https://<account-name>.freshteam.com/api/candidate_source_categories : List All Candidate Source Categories
  • post https://<account-name>.freshteam.com/api/candidate_sources : Create Candidate Source
  • get https://<account-name>.freshteam.com/api/job_posting_fields : List All Job Posting Fields
  • get https://<account-name>.freshteam.com/api/job_postings : List All Job Postings
  • get https://<account-name>.freshteam.com/api/job_postings/{id} : Retrieve Job Posting Information
  • get https://<account-name>.freshteam.com/api/job_postings/{id}/applicant_fields : List All Applicant Fields
  • post https://<account-name>.freshteam.com/api/job_postings/{id}/applicants : Create an Applicant for a Job Posting

Time Off Management

  • get https://<account-name>.freshteam.com/api/time_off_types : List All Timeoff Types
  • get https://<account-name>.freshteam.com/api/time_offs : List All Timeoffs
  • get https://<account-name>.freshteam.com/api/time_offs/{id} : Retrieve Timeoff Information
  • put https://<account-name>.freshteam.com/api/time_offs/{id}/approve : Approve a Timeoff Request
  • put https://<account-name>.freshteam.com/api/time_offs/{id}/cancel : Cancel a Timeoff Request

User Functions

  • get https://<account-name>.freshteam.com/api/user_functions : List all user functions

Freshteam API FAQs

How do I obtain an API key in Freshteam?

  • Answer: To obtain your API key in Freshteam:some text
    1. Log in to your Freshteam account.
    2. Click on your profile icon in the top-right corner.
    3. Select API Settings from the dropdown menu.
    4. Your API key will be displayed under Your API Key.
  • Source: Freshteam API Documentation

What authentication method does the Freshteam API use?

  • Answer: The Freshteam API uses OAuth 2.0 for authentication. You need to obtain an access token by making a call to the Freshteam authentication server and include this token in the Authorization header of your API requests.
  • Source: Freshteam API Documentation

Are there rate limits for the Freshteam API?

  • Answer: Yes, Freshteam enforces rate limits based on your subscription plan and the number of subscribed employees:some text
    • Free Plan: No API access.
    • Trial Plan: 10 requests per minute.
    • Growth and Pro Plans: Maximum of 50 requests per minute.
    • Enterprise Plan: Maximum of 100 requests per minute.
  • Source: Freshteam API Documentation

Can I retrieve employee data using the Freshteam API?

  • Answer: Yes, you can retrieve employee data by making a GET request to the /employees endpoint. This will return a list of employees and their details.
  • Source: Freshteam API Documentation

Does the Freshteam API support webhooks?

  • Answer: Yes, Freshteam supports webhooks, allowing you to receive real-time notifications for specific events, such as when a new employee is added or an employee's information is updated.
  • Source: Freshteam Developers

Get Started with Freshteam API Integration

For quick and seamless integration with Freshteam API, Knit API offers a convenient solution. It’s AI powered integration platform allows you to build any Freshteam API Integration use case. By integrating with Knit just once, you can integrate with multiple other CRMs, HRIS, Accounting, and other systems in one go with a unified approach. Knit takes care of all the authentication, authorization, and ongoing integration maintenance. This approach not only saves time but also ensures a smooth and reliable connection to Freshteam API.‍

To sign up for free, click here. To check the pricing, see our pricing page.

#1 in Ease of Integrations

Trusted by businesses to streamline and simplify integrations seamlessly with GetKnit.