{
  "info": {
    "name": "Freshteam API",
    "description": "REST interface to Freshworks' Freshteam HR and applicant tracking (ATS) product - employees, time-off, job postings, applicants, and onboarding. Base URL: https://{{domain}}.freshteam.com/api. All requests carry an account API token as a Bearer credential (generated in the UI under API Settings). STATUS: Freshworks is sunsetting Freshteam - new subscriptions and renewals are halted from March 7, 2026; existing customers retain API access only through their remaining term.",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
  },
  "auth": {
    "type": "bearer",
    "bearer": [
      { "key": "token", "value": "{{apiToken}}", "type": "string" }
    ]
  },
  "variable": [
    { "key": "baseUrl", "value": "https://{{domain}}.freshteam.com/api", "type": "string" },
    { "key": "domain", "value": "your-account", "type": "string" },
    { "key": "apiToken", "value": "", "type": "string" }
  ],
  "item": [
    {
      "name": "Employees",
      "item": [
        {
          "name": "List employees",
          "request": {
            "method": "GET",
            "header": [],
            "url": { "raw": "{{baseUrl}}/employees?page=1", "host": ["{{baseUrl}}"], "path": ["employees"], "query": [{ "key": "page", "value": "1" }] },
            "description": "Lists employees in the account. Paginated via page, sort, and sort_type."
          }
        },
        {
          "name": "Create an employee",
          "request": {
            "method": "POST",
            "header": [{ "key": "Content-Type", "value": "application/json" }],
            "body": { "mode": "raw", "raw": "{\n  \"first_name\": \"Jane\",\n  \"last_name\": \"Doe\",\n  \"official_email\": \"jane@example.com\",\n  \"designation\": \"Engineer\"\n}" },
            "url": { "raw": "{{baseUrl}}/employees", "host": ["{{baseUrl}}"], "path": ["employees"] },
            "description": "Creates a new employee record."
          }
        },
        {
          "name": "Retrieve an employee",
          "request": {
            "method": "GET",
            "header": [],
            "url": { "raw": "{{baseUrl}}/employees/:id", "host": ["{{baseUrl}}"], "path": ["employees", ":id"], "variable": [{ "key": "id", "value": "" }] },
            "description": "Retrieves an employee by ID."
          }
        },
        {
          "name": "Update an employee",
          "request": {
            "method": "PUT",
            "header": [{ "key": "Content-Type", "value": "application/json" }],
            "body": { "mode": "raw", "raw": "{\n  \"designation\": \"Senior Engineer\"\n}" },
            "url": { "raw": "{{baseUrl}}/employees/:id", "host": ["{{baseUrl}}"], "path": ["employees", ":id"], "variable": [{ "key": "id", "value": "" }] },
            "description": "Updates an existing employee record."
          }
        },
        {
          "name": "List employee fields",
          "request": {
            "method": "GET",
            "header": [],
            "url": { "raw": "{{baseUrl}}/employee_fields", "host": ["{{baseUrl}}"], "path": ["employee_fields"] },
            "description": "Lists the standard and custom fields defined on employee records."
          }
        },
        {
          "name": "List departments",
          "request": {
            "method": "GET",
            "header": [],
            "url": { "raw": "{{baseUrl}}/departments", "host": ["{{baseUrl}}"], "path": ["departments"] },
            "description": "Lists departments in the organization structure."
          }
        },
        {
          "name": "List branches",
          "request": {
            "method": "GET",
            "header": [],
            "url": { "raw": "{{baseUrl}}/branches", "host": ["{{baseUrl}}"], "path": ["branches"] },
            "description": "Lists branches in the organization structure."
          }
        },
        {
          "name": "List roles",
          "request": {
            "method": "GET",
            "header": [],
            "url": { "raw": "{{baseUrl}}/roles", "host": ["{{baseUrl}}"], "path": ["roles"] },
            "description": "Lists roles configured in the account."
          }
        }
      ]
    },
    {
      "name": "Time-off",
      "item": [
        {
          "name": "List time-off requests",
          "request": {
            "method": "GET",
            "header": [],
            "url": { "raw": "{{baseUrl}}/time_offs", "host": ["{{baseUrl}}"], "path": ["time_offs"] },
            "description": "Lists time-off (leave) requests."
          }
        },
        {
          "name": "Create a time-off request",
          "request": {
            "method": "POST",
            "header": [{ "key": "Content-Type", "value": "application/json" }],
            "body": { "mode": "raw", "raw": "{\n  \"applicant_id\": 0,\n  \"leave_type_id\": 0,\n  \"start_date\": \"2026-08-01\",\n  \"end_date\": \"2026-08-03\",\n  \"reason\": \"Vacation\"\n}" },
            "url": { "raw": "{{baseUrl}}/time_offs", "host": ["{{baseUrl}}"], "path": ["time_offs"] },
            "description": "Creates a new time-off request."
          }
        },
        {
          "name": "Approve a time-off request",
          "request": {
            "method": "PUT",
            "header": [],
            "url": { "raw": "{{baseUrl}}/time_offs/:id/approve", "host": ["{{baseUrl}}"], "path": ["time_offs", ":id", "approve"], "variable": [{ "key": "id", "value": "" }] },
            "description": "Approves a pending time-off request."
          }
        },
        {
          "name": "Cancel a time-off request",
          "request": {
            "method": "PUT",
            "header": [],
            "url": { "raw": "{{baseUrl}}/time_offs/:id/cancel", "host": ["{{baseUrl}}"], "path": ["time_offs", ":id", "cancel"], "variable": [{ "key": "id", "value": "" }] },
            "description": "Cancels a time-off request."
          }
        },
        {
          "name": "List time-off types",
          "request": {
            "method": "GET",
            "header": [],
            "url": { "raw": "{{baseUrl}}/time_off_types", "host": ["{{baseUrl}}"], "path": ["time_off_types"] },
            "description": "Lists the configured time-off types."
          }
        }
      ]
    },
    {
      "name": "Job Postings",
      "item": [
        {
          "name": "List job postings",
          "request": {
            "method": "GET",
            "header": [],
            "url": { "raw": "{{baseUrl}}/job_postings", "host": ["{{baseUrl}}"], "path": ["job_postings"] },
            "description": "Lists job postings managed in the ATS."
          }
        },
        {
          "name": "Retrieve a job posting",
          "request": {
            "method": "GET",
            "header": [],
            "url": { "raw": "{{baseUrl}}/job_postings/:id", "host": ["{{baseUrl}}"], "path": ["job_postings", ":id"], "variable": [{ "key": "id", "value": "" }] },
            "description": "Retrieves a job posting by ID."
          }
        },
        {
          "name": "List job posting fields",
          "request": {
            "method": "GET",
            "header": [],
            "url": { "raw": "{{baseUrl}}/job_posting_fields", "host": ["{{baseUrl}}"], "path": ["job_posting_fields"] },
            "description": "Lists the fields defined on job postings."
          }
        }
      ]
    },
    {
      "name": "Applicants",
      "item": [
        {
          "name": "Create an applicant for a job posting",
          "request": {
            "method": "POST",
            "header": [{ "key": "Content-Type", "value": "application/json" }],
            "body": { "mode": "raw", "raw": "{\n  \"first_name\": \"Alex\",\n  \"last_name\": \"Smith\",\n  \"email\": \"alex@example.com\"\n}" },
            "url": { "raw": "{{baseUrl}}/job_postings/:id/applicants", "host": ["{{baseUrl}}"], "path": ["job_postings", ":id", "applicants"], "variable": [{ "key": "id", "value": "" }] },
            "description": "Adds an applicant (candidate) to the specified job posting."
          }
        },
        {
          "name": "List candidate sources",
          "request": {
            "method": "GET",
            "header": [],
            "url": { "raw": "{{baseUrl}}/candidate_sources", "host": ["{{baseUrl}}"], "path": ["candidate_sources"] },
            "description": "Lists candidate sources."
          }
        },
        {
          "name": "Create a candidate source",
          "request": {
            "method": "POST",
            "header": [{ "key": "Content-Type", "value": "application/json" }],
            "body": { "mode": "raw", "raw": "{\n  \"name\": \"Referral\"\n}" },
            "url": { "raw": "{{baseUrl}}/candidate_sources", "host": ["{{baseUrl}}"], "path": ["candidate_sources"] },
            "description": "Creates a new candidate source."
          }
        }
      ]
    },
    {
      "name": "Onboarding",
      "item": [
        {
          "name": "Create a new hire",
          "request": {
            "method": "POST",
            "header": [{ "key": "Content-Type", "value": "application/json" }],
            "body": { "mode": "raw", "raw": "{\n  \"first_name\": \"Sam\",\n  \"last_name\": \"Jones\",\n  \"official_email\": \"sam@example.com\",\n  \"joining_date\": \"2026-09-01\"\n}" },
            "url": { "raw": "{{baseUrl}}/new_hires", "host": ["{{baseUrl}}"], "path": ["new_hires"] },
            "description": "Creates a new-hire record for onboarding."
          }
        },
        {
          "name": "Retrieve a new hire",
          "request": {
            "method": "GET",
            "header": [],
            "url": { "raw": "{{baseUrl}}/new_hires/:id", "host": ["{{baseUrl}}"], "path": ["new_hires", ":id"], "variable": [{ "key": "id", "value": "" }] },
            "description": "Retrieves a new-hire record by ID."
          }
        }
      ]
    }
  ]
}