Freshworks Freshteam API — Employees

naftiko: 1.0.0-alpha2
info:
  label: Freshworks Freshteam API — Employees
  description: 'Freshworks Freshteam API — Employees. 4 operations. Lead operation: List all employee fields. Self-contained
    Naftiko capability covering one Freshworks business surface.'
  tags:
  - Freshworks
  - Employees
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FRESHWORKS_API_KEY: FRESHWORKS_API_KEY
capability:
  consumes:
  - type: http
    namespace: freshteam-employees
    baseUri: https://{domain}.freshteam.com/api
    description: Freshworks Freshteam API — Employees business capability. Self-contained, no shared references.
    resources:
    - name: employee_fields
      path: /employee_fields
      operations:
      - name: listemployeefields
        method: GET
        description: List all employee fields
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: employees
      path: /employees
      operations:
      - name: listemployees
        method: GET
        description: List all employees
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: sort
          in: query
          type: string
          description: Field to sort by.
        - name: sort_type
          in: query
          type: string
          description: Sort direction (asc or desc).
        - name: status
          in: query
          type: string
          description: Filter by employment status.
    - name: employees-employee_id
      path: /employees/{employee_id}
      operations:
      - name: getemployee
        method: GET
        description: View an employee
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateemployee
        method: PUT
        description: Update an employee
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.FRESHWORKS_API_KEY}}'
  exposes:
  - type: rest
    namespace: freshteam-employees-rest
    port: 8080
    description: REST adapter for Freshworks Freshteam API — Employees. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/employee-fields
      name: employee-fields
      description: REST surface for employee_fields.
      operations:
      - method: GET
        name: listemployeefields
        description: List all employee fields
        call: freshteam-employees.listemployeefields
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/employees
      name: employees
      description: REST surface for employees.
      operations:
      - method: GET
        name: listemployees
        description: List all employees
        call: freshteam-employees.listemployees
        with:
          sort: rest.sort
          sort_type: rest.sort_type
          status: rest.status
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/employees/{employee-id}
      name: employees-employee-id
      description: REST surface for employees-employee_id.
      operations:
      - method: GET
        name: getemployee
        description: View an employee
        call: freshteam-employees.getemployee
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateemployee
        description: Update an employee
        call: freshteam-employees.updateemployee
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: freshteam-employees-mcp
    port: 9090
    transport: http
    description: MCP adapter for Freshworks Freshteam API — Employees. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-all-employee-fields
      description: List all employee fields
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: freshteam-employees.listemployeefields
      outputParameters:
      - type: object
        mapping: $.
    - name: list-all-employees
      description: List all employees
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: freshteam-employees.listemployees
      with:
        sort: tools.sort
        sort_type: tools.sort_type
        status: tools.status
      outputParameters:
      - type: object
        mapping: $.
    - name: view-employee
      description: View an employee
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: freshteam-employees.getemployee
      outputParameters:
      - type: object
        mapping: $.
    - name: update-employee
      description: Update an employee
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: freshteam-employees.updateemployee
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.