Freshteam Onboarding API

openapi: 3.0.3
info:
  title: Freshteam Applicants Onboarding API
  description: 'The Freshteam API is the REST interface to Freshworks'' HR and applicant tracking (ATS) product. It covers the HRIS core (employees, custom fields, and organization structure), time-off (leave), recruiting (job postings), the ATS (applicants and candidate sources), and onboarding (new hires). Requests target an account-specific base, https://{domain}.freshteam.com/api, where {domain} is your Freshteam subdomain, and carry an account API token as a Bearer credential (generated in the UI under API Settings). List endpoints are paginated with page, sort, and sort_type query parameters and return total-objects, total-pages, and link response headers.

    STATUS - Freshworks has announced the end-of-life of Freshteam. New subscriptions and renewals are halted starting March 7, 2026; existing customers retain access, and thus API access, only through the end of their subscription term (reported through approximately April 2027). This document models the publicly documented API as it exists during the sunset window; new customers cannot obtain access.'
  version: '1.0'
  contact:
    name: Freshworks - Freshteam
    url: https://developers.freshteam.com/api/
servers:
- url: https://{domain}.freshteam.com/api
  description: Account-specific Freshteam API base
  variables:
    domain:
      default: your-account
      description: Your Freshteam account subdomain.
security:
- bearerAuth: []
tags:
- name: Onboarding
  description: New-hire records for pre-boarding and onboarding.
paths:
  /new_hires:
    post:
      operationId: createNewHire
      tags:
      - Onboarding
      summary: Create a new hire
      description: Creates a new-hire record for onboarding an incoming employee.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NewHire'
      responses:
        '201':
          description: The created new-hire record.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NewHire'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /new_hires/{id}:
    get:
      operationId: getNewHire
      tags:
      - Onboarding
      summary: Retrieve a new hire
      parameters:
      - $ref: '#/components/parameters/IdPath'
      responses:
        '200':
          description: The requested new-hire record.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NewHire'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    IdPath:
      name: id
      in: path
      required: true
      description: The resource identifier.
      schema:
        type: integer
        format: int64
  responses:
    Unauthorized:
      description: Authentication failed or the API token is missing or invalid.
    NotFound:
      description: The requested resource was not found.
  schemas:
    NewHire:
      type: object
      properties:
        id:
          type: integer
          format: int64
        first_name:
          type: string
        last_name:
          type: string
        official_email:
          type: string
          format: email
        joining_date:
          type: string
          format: date
        designation:
          type: string
        department_id:
          type: integer
          format: int64
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Account API token generated in the Freshteam UI under API Settings, passed as Authorization: Bearer YOUR_API_TOKEN.'