Can I use Freshteam as a CLI?

Yes. KosmoKrator exposes a Freshteam CLI through kosmo integrations:call and the provider shortcut command. Commands can return JSON for scripts, CI, and coding agents.

Can I expose Freshteam through MCP?

Yes. The KosmoKrator MCP gateway can expose selected Freshteam tools to clients such as Claude Code, Cursor, Codex, and other MCP-compatible tools.

Where are Freshteam credentials stored?

Freshteam credentials are configured in KosmoKrator's local integration settings and reused by CLI, Lua, and MCP gateway surfaces.

Can I deny write access for Freshteam MCP tools?

Yes. Start the gateway with --write=deny for read-only clients, or use ask/allow only for trusted workspaces.

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.

7 functions 7 read 0 write Bearer token auth

Submit Freshteam feedback View package source

Freshteam CLI Setup

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

# 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 use the same stored profile from scripts, coding CLIs, Lua code mode, and the MCP gateway.

Key	Env var	Type	Required	Label
`access_token`	`FRESHTEAM_ACCESS_TOKEN`	Secret `secret`	yes	Access Token
`domain`	`FRESHTEAM_DOMAIN`	Text `string`	yes	Domain

Call Freshteam Headlessly

Use the generic call form when another coding CLI or script needs a stable universal interface.

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

Use the provider shortcut form for shorter human-facing commands.

kosmo integrations:freshteam freshteam_list_candidates '{
  "page": 1,
  "per_page": 1,
  "status": "example_status"
}' --json

Agent Discovery Commands

These commands return structured output for coding agents that need to inspect capabilities 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

All CLI Functions

Every function below can be called headlessly. The generic form is stable across all integrations; the provider shortcut is shorter but specific to Freshteam.

`freshteam.freshteam_list_candidates`

Read read

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

Parameters: page, per_page, status

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

`freshteam.freshteam_get_candidate`

Read read

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

Parameters: id

Generic CLI call

kosmo integrations:call freshteam.freshteam_get_candidate '{"id":1}' --json

Provider shortcut

kosmo integrations:freshteam freshteam_get_candidate '{"id":1}' --json

`freshteam.freshteam_list_job_postings`

Read read

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

Parameters: page, per_page, status, department_id

Generic CLI call

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

Provider 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`

Read read

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

Parameters: id

Generic CLI call

kosmo integrations:call freshteam.freshteam_get_job_posting '{"id":1}' --json

Provider shortcut

kosmo integrations:freshteam freshteam_get_job_posting '{"id":1}' --json

`freshteam.freshteam_list_employees`

Read read

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

Parameters: page, per_page, department_id

Generic CLI call

kosmo integrations:call freshteam.freshteam_list_employees '{"page":1,"per_page":1,"department_id":1}' --json

Provider shortcut

kosmo integrations:freshteam freshteam_list_employees '{"page":1,"per_page":1,"department_id":1}' --json

`freshteam.freshteam_get_employee`

Read read

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

Parameters: id

Generic CLI call

kosmo integrations:call freshteam.freshteam_get_employee '{"id":1}' --json

Provider shortcut

kosmo integrations:freshteam freshteam_get_employee '{"id":1}' --json

`freshteam.freshteam_get_current_user`

Read read

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

Parameters: none

Generic CLI call

kosmo integrations:call freshteam.freshteam_get_current_user '{}' --json

Provider 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`

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

Operation: Read read
Schema command: kosmo integrations:schema freshteam.freshteam_list_candidates --json

Parameter	Type	Required	Description
`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`

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

Operation: Read read
Schema command: kosmo integrations:schema freshteam.freshteam_get_candidate --json

Parameter	Type	Required	Description
`id`	integer	yes	The candidate ID.

`freshteam.freshteam_list_job_postings`

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

Operation: Read read
Schema command: kosmo integrations:schema freshteam.freshteam_list_job_postings --json

Parameter	Type	Required	Description
`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`

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

Operation: Read read
Schema command: kosmo integrations:schema freshteam.freshteam_get_job_posting --json

Parameter	Type	Required	Description
`id`	integer	yes	The job posting ID.

`freshteam.freshteam_list_employees`

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

Operation: Read read
Schema command: kosmo integrations:schema freshteam.freshteam_list_employees --json

Parameter	Type	Required	Description
`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`

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

Operation: Read read
Schema command: kosmo integrations:schema freshteam.freshteam_get_employee --json

Parameter	Type	Required	Description
`id`	integer	yes	The employee ID.

`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.

Operation: Read read
Schema command: kosmo integrations:schema freshteam.freshteam_get_current_user --json

Parameter	Type	Required	Description
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.