KosmoKrator

productivity

Freshteam CLI for AI Agents

Use the Freshteam CLI from KosmoKrator to call Freshteam tools headlessly, return JSON, inspect schemas, and automate workflows from coding agents, scripts, and CI.

Freshteam CLI Setup

Freshteam can be configured headlessly with `kosmokrator integrations:configure freshteam`.

Install, configure, and verify 
# Install KosmoKrator first if it is not available on PATH.
curl -fsSL https://raw.githubusercontent.com/OpenCompanyApp/kosmokrator/main/install.sh | bash

# Configure and verify this integration.
kosmokrator integrations:configure freshteam --set access_token="$FRESHTEAM_ACCESS_TOKEN" --set domain="$FRESHTEAM_DOMAIN" --enable --read allow --write ask --json
kosmokrator integrations:doctor freshteam --json
kosmokrator integrations:status --json

Credentials

Authentication type: Bearer token bearer_token. Configure credentials once, then reuse the same stored profile from scripts, coding CLIs, Lua, and MCP.

KeyEnv varTypeRequiredLabel
access_token FRESHTEAM_ACCESS_TOKEN Secret secret yes Access Token
domain FRESHTEAM_DOMAIN Text string yes Domain

Command Patterns

The generic command is stable across every integration. The provider shortcut is shorter for humans.

Generic CLI call 
kosmo integrations:call freshteam.freshteam_list_candidates '{"page":1,"per_page":1,"status":"example_status"}' --json
Provider shortcut 
kosmo integrations:freshteam freshteam_list_candidates '{"page":1,"per_page":1,"status":"example_status"}' --json

Discovery

These commands return structured output for coding agents that need to inspect capabilities before choosing a function.

Discovery commands 
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

Automation Contexts

The same configured command surface works in these environments. The command does not change unless the host wrapper, credentials, or permissions change.

CI Run integration calls from CI jobs with JSON output, explicit credentials, and predictable exit status. Cron Jobs Schedule repeatable integration workflows from cron while keeping credentials in KosmoKrator config. Shell Scripts Call integration functions from shell scripts with stable JSON input and output. Headless Automation Use KosmoKrator as a non-interactive integration runtime for local automations and wrappers. Coding Agents Let coding agents discover schemas and execute integration functions through CLI commands or MCP.

CLI Functions

Every function below can be called headlessly. Commands are highlighted, copyable, and scroll horizontally when payloads are long.

freshteam.freshteam_list_candidates

List recruitment candidates from Freshteam. Returns paginated candidate records with optional filtering by status.

Read read
Parameters
page, per_page, status
Generic call 
kosmo integrations:call freshteam.freshteam_list_candidates '{"page":1,"per_page":1,"status":"example_status"}' --json
Shortcut 
kosmo integrations:freshteam freshteam_list_candidates '{"page":1,"per_page":1,"status":"example_status"}' --json

freshteam.freshteam_get_candidate

Retrieve detailed information about a specific candidate in Freshteam by their ID.

Read read
Parameters
id
Generic call 
kosmo integrations:call freshteam.freshteam_get_candidate '{"id":1}' --json
Shortcut 
kosmo integrations:freshteam freshteam_get_candidate '{"id":1}' --json

freshteam.freshteam_list_job_postings

List job postings from Freshteam. Returns paginated job records with optional filtering by status and department.

Read read
Parameters
page, per_page, status, department_id
Generic call 
kosmo integrations:call freshteam.freshteam_list_job_postings '{"page":1,"per_page":1,"status":"example_status","department_id":1}' --json
Shortcut 
kosmo integrations:freshteam freshteam_list_job_postings '{"page":1,"per_page":1,"status":"example_status","department_id":1}' --json

freshteam.freshteam_get_job_posting

Retrieve detailed information about a specific job posting in Freshteam by its ID.

Read read
Parameters
id
Generic call 
kosmo integrations:call freshteam.freshteam_get_job_posting '{"id":1}' --json
Shortcut 
kosmo integrations:freshteam freshteam_get_job_posting '{"id":1}' --json

freshteam.freshteam_list_employees

List employees from Freshteam. Returns paginated employee records with optional filtering by department.

Read read
Parameters
page, per_page, department_id
Generic call 
kosmo integrations:call freshteam.freshteam_list_employees '{"page":1,"per_page":1,"department_id":1}' --json
Shortcut 
kosmo integrations:freshteam freshteam_list_employees '{"page":1,"per_page":1,"department_id":1}' --json

freshteam.freshteam_get_employee

Retrieve detailed information about a specific employee in Freshteam by their ID.

Read read
Parameters
id
Generic call 
kosmo integrations:call freshteam.freshteam_get_employee '{"id":1}' --json
Shortcut 
kosmo integrations:freshteam freshteam_get_employee '{"id":1}' --json

freshteam.freshteam_get_current_user

Retrieve the profile of the currently authenticated Freshteam user. Useful for verifying the connection and identifying which account is active.

Read read
Parameters
none
Generic call 
kosmo integrations:call freshteam.freshteam_get_current_user '{}' --json
Shortcut 
kosmo integrations:freshteam freshteam_get_current_user '{}' --json

Function Schemas

Use these parameter tables when building CLI payloads without calling integrations:schema first.

freshteam.freshteam_list_candidates 3 parameters
Schema command 
kosmo integrations:schema freshteam.freshteam_list_candidates --json
ParameterTypeRequiredDescription
page integer no Page number for pagination (default: 1).
per_page integer no Number of results per page (default: 20, max: 100).
status string no Filter candidates by status (e.g., "active", "hired", "rejected", "on_hold").
freshteam.freshteam_get_candidate 1 parameters
Schema command 
kosmo integrations:schema freshteam.freshteam_get_candidate --json
ParameterTypeRequiredDescription
id integer yes The candidate ID.
freshteam.freshteam_list_job_postings 4 parameters
Schema command 
kosmo integrations:schema freshteam.freshteam_list_job_postings --json
ParameterTypeRequiredDescription
page integer no Page number for pagination (default: 1).
per_page integer no Number of results per page (default: 20, max: 100).
status string no Filter job postings by status (e.g., "published", "draft", "closed", "on_hold").
department_id integer no Filter by department ID.
freshteam.freshteam_get_job_posting 1 parameters
Schema command 
kosmo integrations:schema freshteam.freshteam_get_job_posting --json
ParameterTypeRequiredDescription
id integer yes The job posting ID.
freshteam.freshteam_list_employees 3 parameters
Schema command 
kosmo integrations:schema freshteam.freshteam_list_employees --json
ParameterTypeRequiredDescription
page integer no Page number for pagination (default: 1).
per_page integer no Number of results per page (default: 20, max: 100).
department_id integer no Filter by department ID.
freshteam.freshteam_get_employee 1 parameters
Schema command 
kosmo integrations:schema freshteam.freshteam_get_employee --json
ParameterTypeRequiredDescription
id integer yes The employee ID.
freshteam.freshteam_get_current_user 0 parameters
Schema command 
kosmo integrations:schema freshteam.freshteam_get_current_user --json
ParameterTypeRequiredDescription
No parameters.

Permissions

Headless calls still follow the integration read/write permission policy. Configure read/write defaults with integrations:configure. Add --force only for trusted automation that should bypass that policy.