hr
Freshteam CLI for Shell Scripts
Use the Freshteam CLI for shell scripts with headless JSON commands, schema discovery, credentials, and permission controls.
7 functions 7 read 0 write Bearer token auth
Freshteam CLI for Shell Scripts
Call integration functions from shell scripts with stable JSON input and output.
Use shell scripts for small local automations that need one or more integration calls. The Freshteam CLI uses the same integration registry as the TUI, Lua runtime, and MCP gateway, but returns predictable command output for automation.
Command Shape
# Freshteam CLI for Shell Scripts
kosmokrator integrations:configure freshteam --set access_token="$FRESHTEAM_ACCESS_TOKEN" --set domain="$FRESHTEAM_DOMAIN" --enable --read allow --write ask --json
kosmo integrations:call freshteam.freshteam_list_candidates '{"page":1,"per_page":1,"status":"example_status"}' --json Discovery Before Execution
Agents and scripts can inspect Freshteam docs and schemas before choosing a function.
kosmo integrations:docs freshteam --json
kosmo integrations:docs freshteam.freshteam_list_candidates --json
kosmo integrations:schema freshteam.freshteam_list_candidates --json
kosmo integrations:search "Freshteam" --json
kosmo integrations:list --json Useful Freshteam CLI Functions
| Function | Type | Parameters | Description |
|---|---|---|---|
freshteam.freshteam_list_candidates | Read | page, per_page, status | List recruitment candidates from Freshteam. Returns paginated candidate records with optional filtering by status. |
freshteam.freshteam_get_candidate | Read | id | Retrieve detailed information about a specific candidate in Freshteam by their ID. |
freshteam.freshteam_list_job_postings | Read | page, per_page, status, department_id | List job postings from Freshteam. Returns paginated job records with optional filtering by status and department. |
freshteam.freshteam_get_job_posting | Read | id | Retrieve detailed information about a specific job posting in Freshteam by its ID. |
freshteam.freshteam_list_employees | Read | page, per_page, department_id | List employees from Freshteam. Returns paginated employee records with optional filtering by department. |
freshteam.freshteam_get_employee | Read | id | Retrieve detailed information about a specific employee in Freshteam by their ID. |
freshteam.freshteam_get_current_user | Read | none | Retrieve the profile of the currently authenticated Freshteam user. Useful for verifying the connection and identifying which account is active. |
Automation Notes
- Use
--jsonfor machine-readable output. - Keep credentials out of argv by using environment variables or stored KosmoKrator configuration.
- Configure read/write policy before unattended runs; use
--forceonly for trusted automation. - Use the MCP gateway instead when the agent needs dynamic tool discovery inside a conversation.