> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to Freshsales

The Freshsales connector lets your AI agent act in each user's Freshsales account. Each user connects their own Freshsales API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 30 tools.

**Authentication:** API Key
**Categories:** CRM & Sales
**Tools:** 30: 17 read, 13 write, 0 destructive
**Users sign in with:** API key
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=FRESHSALES)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the Freshsales connection

   In **AgentKit > Connections**, create a Freshsales connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   import { createInterface } from 'node:readline/promises'

   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENVIRONMENT_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions

   const connector = 'freshsales'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize Freshsales:', link)
   const rl = createInterface({ input: process.stdin, output: process.stdout })
   await rl.question('Press Enter after authorizing...')
   rl.close()

   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'freshsales_appointments_list',
     toolInput: {},
   })
   console.log(result)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()

   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions

   connection_name = "freshsales"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize Freshsales:", link_response.link)
   input("Press Enter after authorizing...")

   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="freshsales_appointments_list",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their Freshsales credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'freshsales_appointment_get',
  toolInput: {
    appointment_id: 16000123456,
  },
  connector: 'freshsales',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="freshsales_appointment_get",
    tool_input={
        "appointment_id": 16000123456,
    },
    connection_name="freshsales",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `freshsales_appointment_get`

Get Appointment · Read-only

Get one Freshsales appointment by ID.
Returns the appointment's title, start and end, time zone, location, linked record and attendees.
Use this when you have an appointment ID. Use freshsales_appointments_list to find appointments.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `appointment_id` (`integer`, required): Numeric ID of the appointment. Get it from freshsales_appointments_list. Example: 16000123456.

Example input: `{"appointment_id":16000123456}`

### `freshsales_appointments_list`

List Appointments · Read-only

List Freshsales appointments, either upcoming or past.
Returns the appointments with id, title, start and end, and time zone.
Use this to review a calendar. Use freshsales_appointment_get for one appointment's full details.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `filter` (`string`, optional): Which appointments to return. Use open for upcoming appointments (the default). Freshsales documents the other value as complete (past appointments). Example: open. Default: `open`.
- `include` (`string`, optional): Comma-separated related records to embed in the appointments response. Allowed values: creater, targetable, appointment_attendees. Example: targetable,appointment_attendees.
- `page` (`integer`, optional): Page number to return, starting at 1. Each page holds 25 records by default. Example: 2.

Example input: `{}`

### `freshsales_contact_get`

Get Contact · Read-only

Get one Freshsales contact by ID.
Returns the contact's fields, emails, custom fields and any related records requested in include.
Use this when you have a contact ID. Use freshsales_search or freshsales_lookup to find one by name or email.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `contact_id` (`integer`, required): Numeric ID of the contact. Get it from freshsales_search or freshsales_contacts_list. Example: 16000123456.
- `include` (`string`, optional): Comma-separated related records to embed in the contact response. Allowed values: sales_accounts, owner, creater, updater, source, campaign, tasks, appointments, notes, deals, territory, sales_activities. Example: sales_accounts,owner.

Example input: `{"contact_id":16000123456}`

### `freshsales_contacts_list`

List Contacts · Read-only

List the contacts in a Freshsales view, one page at a time.
Returns up to 25 contacts per page with id, name, email, phone and lead score, plus meta.total.
Use this to browse contacts. Use freshsales_search to find contacts by text.
Get a view_id from freshsales_views_list (entity contacts) first.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `view_id` (`integer`, required): Numeric ID of the view. Get it from freshsales_views_list with entity contacts. Example: 16000001234.
- `page` (`integer`, optional): Page number to return, starting at 1. Each page holds 25 records by default. Example: 2.
- `sort` (`string`, optional): Field to sort the contacts by. One of: lead_score, created_at, updated_at, open_deals_amount, last_contacted. Example: updated_at. One of: `lead_score`, `created_at`, `updated_at`, `open_deals_amount`, `last_contacted`.
- `sort_type` (`string`, optional): Sort direction: asc for ascending or desc for descending. Example: desc. One of: `asc`, `desc`.

Example input: `{"view_id":16000001234}`

### `freshsales_deal_get`

Get Deal · Read-only

Get one Freshsales deal by ID.
Returns the deal's amount, stage, expected close date, custom fields and any related records requested in include.
Use this when you have a deal ID. Use freshsales_search to find one by name.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `deal_id` (`integer`, required): Numeric ID of the deal. Get it from freshsales_search or freshsales_deals_list. Example: 16000123456.
- `include` (`string`, optional): Comma-separated related records to embed in the deal response. Allowed values: sales_account, owner, creater, updater, source, contacts, deal_stage, deal_reason, deal_type, campaign, deal_payment_status, deal_product, currency, sales_activities. Example: sales_account,deal_stage,contacts.

Example input: `{"deal_id":16000123456}`

### `freshsales_deals_list`

List Deals · Read-only

List the deals in a Freshsales view, one page at a time.
Returns up to 25 deals per page with id, name, amount, stage and expected close date, plus meta.total.
Use this to browse a pipeline. Use freshsales_search to find deals by name.
Get a view_id from freshsales_views_list (entity deals) first.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `view_id` (`integer`, required): Numeric ID of the view. Get it from freshsales_views_list with entity deals. Example: 16000001234.
- `page` (`integer`, optional): Page number to return, starting at 1. Each page holds 25 records by default. Example: 2.
- `sort` (`string`, optional): Field to sort the deals by. One of: amount, expected_close, created_at, updated_at, last_contacted. Example: updated_at. One of: `amount`, `expected_close`, `created_at`, `updated_at`, `last_contacted`.
- `sort_type` (`string`, optional): Sort direction: asc for ascending or desc for descending. Example: desc. One of: `asc`, `desc`.

Example input: `{"view_id":16000001234}`

### `freshsales_lookup`

Lookup Records · Read-only

Find Freshsales contacts, accounts or deals whose field exactly equals a value, such as an email address or name.
Returns the matching records grouped by record type.
Use this to check whether a record exists before creating one. Use freshsales_search for partial or free-text matches.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `entities` (`string`, required): Comma-separated record types to look in: contact, sales_account, deal. Every listed type must have the field in f. Example: contact.
- `f` (`string`, required): Field to match against. Contacts support name, email and text, number, dropdown or radio custom fields (by internal name, e.g. cf_region); accounts and deals support name and the same custom field types. Example: email.
- `q` (`string`, required): Exact value to match. Partial values do not match. Example: jane@acme.com.

Example input: `{"entities":"<entities>","f":"<f>","q":"<q>"}`

### `freshsales_owners_list`

List Owners · Read-only

List the users in the Freshsales account who can own records.
Returns each user's id and display name.
Use this to find the owner_id to assign contacts, accounts, deals, tasks and sales activities.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `freshsales_sales_account_get`

Get Account · Read-only

Get one Freshsales account (company) by ID.
Returns the account's fields, custom fields and any related records requested in include, such as its contacts and deals.
Use this when you have an account ID. Use freshsales_search to find one by name.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `sales_account_id` (`integer`, required): Numeric ID of the account. Get it from freshsales_search or freshsales_sales_accounts_list. Example: 16000123456.
- `include` (`string`, optional): Comma-separated related records to embed in the account response. Allowed values: owner, creater, updater, territory, business_type, tasks, appointments, contacts, deals, industry_type, child_sales_accounts. Example: contacts,deals.

Example input: `{"sales_account_id":16000123456}`

### `freshsales_sales_accounts_list`

List Accounts · Read-only

List the accounts (companies) in a Freshsales view, one page at a time.
Returns up to 25 accounts per page with id, name, website and open deal amount, plus meta.total.
Use this to browse accounts. Use freshsales_search to find accounts by name.
Get a view_id from freshsales_views_list (entity sales_accounts) first.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `view_id` (`integer`, required): Numeric ID of the view. Get it from freshsales_views_list with entity sales_accounts. Example: 16000001234.
- `page` (`integer`, optional): Page number to return, starting at 1. Each page holds 25 records by default. Example: 2.
- `sort` (`string`, optional): Field to sort the accounts by. One of: open_deals_amount, created_at, updated_at, last_contacted. Example: updated_at. One of: `open_deals_amount`, `created_at`, `updated_at`, `last_contacted`.
- `sort_type` (`string`, optional): Sort direction: asc for ascending or desc for descending. Example: desc. One of: `asc`, `desc`.

Example input: `{"view_id":16000001234}`

### `freshsales_sales_activities_list`

List Sales Activities · Read-only

List the sales activities in the Freshsales account, one page at a time.
Returns activities with id, title, type, outcome, start and end, owner and linked record, plus pagination meta.
Use this to review logged activity. Use freshsales_sales_activity_get for one activity.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page` (`integer`, optional): Page number to return, starting at 1. Each page holds 25 records by default. Example: 2.
- `per_page` (`integer`, optional): Number of activities per page. Example: 25.

Example input: `{}`

### `freshsales_sales_activity_get`

Get Sales Activity · Read-only

Get one Freshsales sales activity by ID.
Returns the activity's title, type, outcome, start and end, notes, owner and linked record.
Use this when you have an activity ID. Use freshsales_sales_activities_list to browse activities.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `sales_activity_id` (`integer`, required): Numeric ID of the sales activity. Get it from freshsales_sales_activities_list. Example: 16000123456.

Example input: `{"sales_activity_id":16000123456}`

### `freshsales_search`

Search Records · Read-only

Search Freshsales contacts, accounts, deals and users by name or email text.
Returns matching records with id, name, type and (for contacts and users) email; partial matches are included.
Use this for a free-text search. Use freshsales_lookup for an exact match on one field, such as an email address.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `include` (`string`, required): Comma-separated record types to search: contact, sales_account, deal, user. Freshsales returns nothing when this is empty. Example: contact,sales_account.
- `q` (`string`, required): Text to search for in record names and email addresses. Example: acme.
- `per_page` (`integer`, optional): Maximum number of results to return, up to 100. Defaults to 10. Example: 25.

Example input: `{"include":"<include>","q":"<q>"}`

### `freshsales_selector_options_list`

List Selector Options · Read-only

List the allowed values for a Freshsales configuration field, such as deal stages, lead sources or sales activity types.
Returns each option's id and name (deal stages also include deal_pipeline_id).
Use this to find the ID to pass in fields like deal_stage_id, lead_source_id or sales_activity_type_id. Use freshsales_owners_list for users.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `selector` (`string`, required): Which configuration list to return. Example: deal_stages returns the stages of the default pipeline; sales_activity_types returns the activity types used by sales activities. One of: `owners`, `territories`, `deal_stages`, `currencies`, `deal_reasons`, `deal_types`, `lead_sources`, `industry_types`, `business_types`, `campaigns`, `deal_payment_statuses`, `deal_products`, `deal_pipelines`, `contact_statuses`, `sales_activity_types`, `sales_activity_outcomes`, `sales_activity_entity_types`, `lifecycle_stages`, `designations`.

Example input: `{"selector":"owners"}`

### `freshsales_task_get`

Get Task · Read-only

Get one Freshsales task by ID.
Returns the task's title, description, due date, status, owner ID and any related records requested in include.
Use this when you have a task ID. Use freshsales_tasks_list to find tasks.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `task_id` (`integer`, required): Numeric ID of the task. Get it from freshsales_tasks_list or a contact's tasks. Example: 16000123456.
- `include` (`string`, optional): Comma-separated related records to embed in the task response. Allowed values: users (the task's collaborators) and targetable (the linked contact, account or deal). Example: users,targetable.

Example input: `{"task_id":16000123456}`

### `freshsales_tasks_list`

List Tasks · Read-only

List Freshsales tasks matching one status filter: open, due today, due tomorrow, overdue or completed.
Returns the tasks with id, title, due date, status and owner.
Use this to review a to-do list. Use freshsales_task_get for one task's full details.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `filter` (`string`, required): Which tasks to return: open, due_today, due_tomorrow, overdue or completed. Only one filter per call. Example: open. One of: `open`, `due_today`, `due_tomorrow`, `overdue`, `completed`.
- `include` (`string`, optional): Comma-separated related records to embed in the tasks response. Allowed values: users, targetable, owner. Example: targetable,owner.
- `page` (`integer`, optional): Page number to return, starting at 1. Each page holds 25 records by default. Example: 2.

Example input: `{"filter":"open"}`

### `freshsales_views_list`

List Views · Read-only

List the saved views (filters) for contacts, accounts or deals in Freshsales.
Returns each view's id and name.
Use this first to get a view_id for freshsales_contacts_list, freshsales_sales_accounts_list or freshsales_deals_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `entity` (`string`, required): Record type to list views for: contacts, sales_accounts (accounts) or deals. Example: contacts. One of: `contacts`, `sales_accounts`, `deals`.

Example input: `{"entity":"contacts"}`

### `freshsales_appointment_create`

Create Appointment · Write

Schedule an appointment (meeting) in Freshsales, optionally linked to a contact, account or deal and with attendees.
Returns the new appointment with its id.
Use freshsales_appointment_update to reschedule an existing appointment.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `end_date` (`string`, required): End of the appointment as an ISO 8601 datetime (or a date for an all-day appointment). Example: 2026-11-20T15:30:00Z.
- `from_date` (`string`, required): Start of the appointment as an ISO 8601 datetime (or a date for an all-day appointment). Example: 2026-11-20T15:00:00Z.
- `title` (`string`, required): Title of the appointment. Example: Product demo with Acme.
- `attendee_contact_ids` (`array`, optional): IDs of contacts to invite. Example: [16000123456].
- `attendee_user_ids` (`array`, optional): IDs of Freshsales users to invite. Get user IDs from freshsales_owners_list. Example: [16000012345].
- `description` (`string`, optional): Agenda or details of the appointment. Example: Walk through the reporting module.
- `is_allday` (`boolean`, optional): Set to true for an all-day appointment; then from_date and end_date are dates. Example: false.
- `location` (`string`, optional): Where the appointment takes place. Example: Zoom.
- `outcome_id` (`integer`, optional): ID of the outcome. Get valid IDs from freshsales_selector_options_list with selector sales_activity_outcomes. Example: 16000000123.
- `targetable_id` (`integer`, optional): ID of the contact, account or deal the appointment is linked to, matching targetable_type. Example: 16000123456.
- `targetable_type` (`string`, optional): Type of record the appointment is linked to: Contact, SalesAccount (an account) or Deal. Example: Contact. One of: `Contact`, `SalesAccount`, `Deal`.
- `time_zone` (`string`, optional): Time zone the appointment is scheduled in, as a Rails time zone name. Example: Pacific Time (US & Canada).

Example input: `{"end_date":"<end_date>","from_date":"<from_date>","title":"<title>"}`

### `freshsales_appointment_update`

Update Appointment · Write

Update an existing Freshsales appointment, for example to reschedule it or change attendees.
Returns the updated appointment. Only the fields you pass are changed.
Use freshsales_appointment_create to schedule a new appointment.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `appointment_id` (`integer`, required): Numeric ID of the appointment. Get it from freshsales_appointments_list. Example: 16000123456.
- `attendee_contact_ids` (`array`, optional): IDs of contacts to invite. Example: [16000123456].
- `attendee_user_ids` (`array`, optional): IDs of Freshsales users to invite. Get user IDs from freshsales_owners_list. Example: [16000012345].
- `description` (`string`, optional): Agenda or details of the appointment. Example: Walk through the reporting module.
- `end_date` (`string`, optional): End of the appointment as an ISO 8601 datetime (or a date for an all-day appointment). Example: 2026-11-20T15:30:00Z.
- `from_date` (`string`, optional): Start of the appointment as an ISO 8601 datetime (or a date for an all-day appointment). Example: 2026-11-20T15:00:00Z.
- `is_allday` (`boolean`, optional): Set to true for an all-day appointment; then from_date and end_date are dates. Example: false.
- `location` (`string`, optional): Where the appointment takes place. Example: Zoom.
- `outcome_id` (`integer`, optional): ID of the outcome. Get valid IDs from freshsales_selector_options_list with selector sales_activity_outcomes. Example: 16000000123.
- `targetable_id` (`integer`, optional): ID of the contact, account or deal the appointment is linked to, matching targetable_type. Example: 16000123456.
- `targetable_type` (`string`, optional): Type of record the appointment is linked to: Contact, SalesAccount (an account) or Deal. Example: Contact. One of: `Contact`, `SalesAccount`, `Deal`.
- `time_zone` (`string`, optional): Time zone the appointment is scheduled in, as a Rails time zone name. Example: Pacific Time (US & Canada).
- `title` (`string`, optional): Title of the appointment. Example: Product demo with Acme.

Example input: `{"appointment_id":16000123456}`

### `freshsales_contact_create`

Create Contact · Write

Create a contact (a person) in Freshsales.
Returns the new contact with its id.
Use freshsales_lookup first to avoid duplicates. Use freshsales_contact_update to change an existing contact.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `address` (`string`, optional): Street address. Example: 100 Market St.
- `city` (`string`, optional): City. Example: San Francisco.
- `contact_status_id` (`integer`, optional): ID of the contact status. Get valid IDs from freshsales_selector_options_list with selector contact_statuses. Example: 16000000123.
- `country` (`string`, optional): Country. Example: USA.
- `custom_field` (`object`, optional): Custom field values for the contact, keyed by the field's internal name (which starts with cf_). Example: {"cf_is_active": true, "cf_region": "EMEA"}.
- `email` (`string`, optional): Primary email address of the contact. A contact needs at least one of email, mobile_number or twitter. Example: jane@acme.com.
- `first_name` (`string`, optional): First name of the contact. Example: Jane.
- `job_title` (`string`, optional): Job title of the contact. Example: VP Sales.
- `last_name` (`string`, optional): Last name of the contact. Example: Sampleton.
- `lead_source_id` (`integer`, optional): ID of the lead source. Get valid IDs from freshsales_selector_options_list with selector lead_sources. Example: 16000000123.
- `lifecycle_stage_id` (`integer`, optional): ID of the lifecycle stage. Get valid IDs from freshsales_selector_options_list with selector lifecycle_stages. Example: 16000000123.
- `mobile_number` (`string`, optional): Mobile phone number; must be unique across contacts. Example: +1-415-555-0199.
- `owner_id` (`integer`, optional): ID of the Freshsales user who owns the contact. Get user IDs from freshsales_owners_list. Example: 16000012345.
- `sales_accounts` (`array`, optional): Accounts to link the contact to. Each item has the account id and is_primary (true for exactly one). Example: [{"id": 16000045678, "is_primary": true}].
- `state` (`string`, optional): State or region. Example: California.
- `territory_id` (`integer`, optional): ID of the territory. Get valid IDs from freshsales_selector_options_list with selector territories. Example: 16000000123.
- `twitter` (`string`, optional): Twitter username of the contact, without @. Example: janesampleton.
- `work_number` (`string`, optional): Work phone number. Example: +1-415-555-0100.
- `zipcode` (`string`, optional): Postal code. Example: 94105.

Example input: `{}`

### `freshsales_contact_update`

Update Contact · Write

Update fields on an existing Freshsales contact.
Returns the updated contact. Only the fields you pass are changed.
Use freshsales_contact_create to add a new contact.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `contact_id` (`integer`, required): Numeric ID of the contact. Get it from freshsales_search or freshsales_contacts_list. Example: 16000123456.
- `address` (`string`, optional): Street address. Example: 100 Market St.
- `city` (`string`, optional): City. Example: San Francisco.
- `contact_status_id` (`integer`, optional): ID of the contact status. Get valid IDs from freshsales_selector_options_list with selector contact_statuses. Example: 16000000123.
- `country` (`string`, optional): Country. Example: USA.
- `custom_field` (`object`, optional): Custom field values for the contact, keyed by the field's internal name (which starts with cf_). Example: {"cf_is_active": true, "cf_region": "EMEA"}.
- `emails` (`array`, optional): Email addresses to set on the contact. Each item has value and is_primary; include the existing email's id to change it, or "_destroy": true with its id to remove it. Example: [{"value": "jane@acme.com", "is_primary": true}].
- `first_name` (`string`, optional): First name of the contact. Example: Jane.
- `job_title` (`string`, optional): Job title of the contact. Example: VP Sales.
- `last_name` (`string`, optional): Last name of the contact. Example: Sampleton.
- `lead_source_id` (`integer`, optional): ID of the lead source. Get valid IDs from freshsales_selector_options_list with selector lead_sources. Example: 16000000123.
- `lifecycle_stage_id` (`integer`, optional): ID of the lifecycle stage. Get valid IDs from freshsales_selector_options_list with selector lifecycle_stages. Example: 16000000123.
- `mobile_number` (`string`, optional): Mobile phone number; must be unique across contacts. Example: +1-415-555-0199.
- `owner_id` (`integer`, optional): ID of the Freshsales user who owns the contact. Get user IDs from freshsales_owners_list. Example: 16000012345.
- `sales_accounts` (`array`, optional): Accounts to link the contact to. Each item has the account id and is_primary (true for exactly one). Example: [{"id": 16000045678, "is_primary": true}].
- `state` (`string`, optional): State or region. Example: California.
- `territory_id` (`integer`, optional): ID of the territory. Get valid IDs from freshsales_selector_options_list with selector territories. Example: 16000000123.
- `work_number` (`string`, optional): Work phone number. Example: +1-415-555-0100.
- `zipcode` (`string`, optional): Postal code. Example: 94105.

Example input: `{"contact_id":16000123456}`

### `freshsales_deal_create`

Create Deal · Write

Create a deal (sales opportunity) in Freshsales, linked to an account.
Returns the new deal with its id.
Use freshsales_deal_update to move an existing deal to another stage or change its amount.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `amount` (`number`, required): Value of the deal in the deal currency. Example: 23456.
- `name` (`string`, required): Name of the deal. Example: Acme - 50 seats.
- `sales_account_id` (`integer`, required): ID of the account the deal belongs to. Freshsales requires an account on every deal. Get it from freshsales_search or freshsales_sales_account_create. Example: 16000045678.
- `contacts_added_list` (`array`, optional): IDs of contacts to link to the deal. Example: [16000123456, 16000123457].
- `currency_id` (`integer`, optional): ID of the currency. Get valid IDs from freshsales_selector_options_list with selector currencies. Example: 16000000123.
- `custom_field` (`object`, optional): Custom field values for the deal, keyed by the field's internal name (which starts with cf_). Example: {"cf_is_active": true, "cf_region": "EMEA"}.
- `deal_pipeline_id` (`integer`, optional): ID of the deal pipeline. Get valid IDs from freshsales_selector_options_list with selector deal_pipelines. Example: 16000000123.
- `deal_stage_id` (`integer`, optional): ID of the deal stage. Get valid IDs from freshsales_selector_options_list with selector deal_stages. Example: 16000000123.
- `deal_type_id` (`integer`, optional): ID of the deal type. Get valid IDs from freshsales_selector_options_list with selector deal_types. Example: 16000000123.
- `expected_close` (`string`, optional): Date the deal is expected to close, as YYYY-MM-DD. Example: 2026-12-31.
- `lead_source_id` (`integer`, optional): ID of the lead source. Get valid IDs from freshsales_selector_options_list with selector lead_sources. Example: 16000000123.
- `owner_id` (`integer`, optional): ID of the Freshsales user who owns the deal. Get user IDs from freshsales_owners_list. Example: 16000012345.
- `probability` (`integer`, optional): Probability of winning the deal, from 0 to 100. Example: 60.
- `territory_id` (`integer`, optional): ID of the territory. Get valid IDs from freshsales_selector_options_list with selector territories. Example: 16000000123.

Example input: `{"amount":23456,"name":"<name>","sales_account_id":16000045678}`

### `freshsales_deal_update`

Update Deal · Write

Update fields on an existing Freshsales deal, such as its stage, amount or linked contacts.
Returns the updated deal. Only the fields you pass are changed.
Use freshsales_deal_create to add a new deal.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `deal_id` (`integer`, required): Numeric ID of the deal. Get it from freshsales_search or freshsales_deals_list. Example: 16000123456.
- `amount` (`number`, optional): Value of the deal in the deal currency. Example: 23456.
- `contacts_added_list` (`array`, optional): IDs of contacts to link to the deal. Example: [16000123456, 16000123457].
- `contacts_removed_list` (`array`, optional): IDs of contacts to unlink from the deal. Example: [16000123457].
- `currency_id` (`integer`, optional): ID of the currency. Get valid IDs from freshsales_selector_options_list with selector currencies. Example: 16000000123.
- `custom_field` (`object`, optional): Custom field values for the deal, keyed by the field's internal name (which starts with cf_). Example: {"cf_is_active": true, "cf_region": "EMEA"}.
- `deal_pipeline_id` (`integer`, optional): ID of the deal pipeline. Get valid IDs from freshsales_selector_options_list with selector deal_pipelines. Example: 16000000123.
- `deal_reason_id` (`integer`, optional): ID of the reason the deal was lost; only allowed when the deal is in a Lost stage. Get valid IDs from freshsales_selector_options_list with selector deal_reasons. Example: 16000000123.
- `deal_stage_id` (`integer`, optional): ID of the deal stage. Get valid IDs from freshsales_selector_options_list with selector deal_stages. Example: 16000000123.
- `deal_type_id` (`integer`, optional): ID of the deal type. Get valid IDs from freshsales_selector_options_list with selector deal_types. Example: 16000000123.
- `expected_close` (`string`, optional): Date the deal is expected to close, as YYYY-MM-DD. Example: 2026-12-31.
- `lead_source_id` (`integer`, optional): ID of the lead source. Get valid IDs from freshsales_selector_options_list with selector lead_sources. Example: 16000000123.
- `name` (`string`, optional): Name of the deal. Example: Acme - 50 seats.
- `owner_id` (`integer`, optional): ID of the Freshsales user who owns the deal. Get user IDs from freshsales_owners_list. Example: 16000012345.
- `probability` (`integer`, optional): Probability of winning the deal, from 0 to 100. Example: 60.
- `sales_account_id` (`integer`, optional): ID of the account the deal belongs to. Freshsales requires an account on every deal. Get it from freshsales_search or freshsales_sales_account_create. Example: 16000045678.
- `territory_id` (`integer`, optional): ID of the territory. Get valid IDs from freshsales_selector_options_list with selector territories. Example: 16000000123.

Example input: `{"deal_id":16000123456}`

### `freshsales_note_create`

Create Note · Write

Add a note to a Freshsales contact, account or deal.
Returns the new note with its id and timestamps.
Use this to record free-text context. Use freshsales_sales_activity_create to log a call or meeting with an outcome.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `description` (`string`, required): Text of the note. Example: Spoke with Jane; she wants a demo next week.
- `targetable_id` (`integer`, required): ID of the contact, account or deal the note is linked to, matching targetable_type. Example: 16000123456.
- `targetable_type` (`string`, required): Type of record the note is linked to: Contact, SalesAccount (an account) or Deal. Example: Contact. One of: `Contact`, `SalesAccount`, `Deal`.

Example input: `{"description":"<description>","targetable_id":16000123456,"targetable_type":"Contact"}`

### `freshsales_sales_account_create`

Create Account · Write

Create an account (a company) in Freshsales.
Returns the new account with its id.
Use freshsales_lookup with f=name first to avoid duplicates. Use freshsales_sales_account_update to change an existing account.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Name of the account (company); must be unique. Example: Acme Inc.
- `address` (`string`, optional): Street address. Example: 100 Market St.
- `annual_revenue` (`number`, optional): Annual revenue of the account. Example: 5000000.
- `business_type_id` (`integer`, optional): ID of the business type. Get valid IDs from freshsales_selector_options_list with selector business_types. Example: 16000000123.
- `city` (`string`, optional): City. Example: San Francisco.
- `country` (`string`, optional): Country. Example: USA.
- `custom_field` (`object`, optional): Custom field values for the account, keyed by the field's internal name (which starts with cf_). Example: {"cf_is_active": true, "cf_region": "EMEA"}.
- `industry_type_id` (`integer`, optional): ID of the industry type. Get valid IDs from freshsales_selector_options_list with selector industry_types. Example: 16000000123.
- `owner_id` (`integer`, optional): ID of the Freshsales user who owns the account. Get user IDs from freshsales_owners_list. Example: 16000012345.
- `parent_sales_account_id` (`integer`, optional): ID of the parent account, for a subsidiary. Example: 16000045678.
- `phone` (`string`, optional): Main phone number. Example: +1-415-555-0100.
- `state` (`string`, optional): State or region. Example: California.
- `territory_id` (`integer`, optional): ID of the territory. Get valid IDs from freshsales_selector_options_list with selector territories. Example: 16000000123.
- `website` (`string`, optional): Website of the account. Example: https://acme.com.
- `zipcode` (`string`, optional): Postal code. Example: 94105.

Example input: `{"name":"<name>"}`

### `freshsales_sales_account_update`

Update Account · Write

Update fields on an existing Freshsales account (company).
Returns the updated account. Only the fields you pass are changed.
Use freshsales_sales_account_create to add a new account.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `sales_account_id` (`integer`, required): Numeric ID of the account. Get it from freshsales_search or freshsales_sales_accounts_list. Example: 16000123456.
- `address` (`string`, optional): Street address. Example: 100 Market St.
- `annual_revenue` (`number`, optional): Annual revenue of the account. Example: 5000000.
- `business_type_id` (`integer`, optional): ID of the business type. Get valid IDs from freshsales_selector_options_list with selector business_types. Example: 16000000123.
- `city` (`string`, optional): City. Example: San Francisco.
- `country` (`string`, optional): Country. Example: USA.
- `custom_field` (`object`, optional): Custom field values for the account, keyed by the field's internal name (which starts with cf_). Example: {"cf_is_active": true, "cf_region": "EMEA"}.
- `industry_type_id` (`integer`, optional): ID of the industry type. Get valid IDs from freshsales_selector_options_list with selector industry_types. Example: 16000000123.
- `name` (`string`, optional): Name of the account (company); must be unique. Example: Acme Inc.
- `owner_id` (`integer`, optional): ID of the Freshsales user who owns the account. Get user IDs from freshsales_owners_list. Example: 16000012345.
- `parent_sales_account_id` (`integer`, optional): ID of the parent account, for a subsidiary. Example: 16000045678.
- `phone` (`string`, optional): Main phone number. Example: +1-415-555-0100.
- `state` (`string`, optional): State or region. Example: California.
- `territory_id` (`integer`, optional): ID of the territory. Get valid IDs from freshsales_selector_options_list with selector territories. Example: 16000000123.
- `website` (`string`, optional): Website of the account. Example: https://acme.com.
- `zipcode` (`string`, optional): Postal code. Example: 94105.

Example input: `{"sales_account_id":16000123456}`

### `freshsales_sales_activity_create`

Create Sales Activity · Write

Log a sales activity, such as a call or meeting of a custom activity type, against a Freshsales contact, account or deal.
Returns the new sales activity with its id.
Use freshsales_note_create for plain notes and freshsales_appointment_create to schedule a future meeting.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `end_date` (`string`, required): End of the activity as an ISO 8601 datetime. Example: 2026-11-14T17:30:00+05:30.
- `owner_id` (`integer`, required): ID of the Freshsales user who owns the sales activity. Get user IDs from freshsales_owners_list. Example: 16000012345.
- `sales_activity_type_id` (`integer`, required): ID of the sales activity type (for example a call or meeting type). Get valid IDs from freshsales_selector_options_list with selector sales_activity_types. Example: 16000000123.
- `start_date` (`string`, required): Start of the activity as an ISO 8601 datetime. Example: 2026-11-14T17:00:00+05:30.
- `targetable_id` (`integer`, required): ID of the contact, account or deal the sales activity is linked to, matching targetable_type. Example: 16000123456.
- `targetable_type` (`string`, required): Type of record the sales activity is linked to: Contact, SalesAccount (an account) or Deal. Example: Contact. One of: `Contact`, `SalesAccount`, `Deal`.
- `title` (`string`, required): Title of the sales activity. Example: Discovery call with Jane.
- `custom_field` (`object`, optional): Custom field values for the sales activity, keyed by the field's internal name (which starts with cf_). Example: {"cf_is_active": true, "cf_region": "EMEA"}.
- `location` (`string`, optional): Where the activity took place. Example: Acme HQ.
- `notes` (`string`, optional): Notes about the activity. Example: Interested in the annual plan.
- `sales_activity_outcome_id` (`integer`, optional): ID of the outcome. Get valid IDs from freshsales_selector_options_list with selector sales_activity_outcomes. Example: 16000000123.

Example input: `{"end_date":"<end_date>","owner_id":16000012345,"sales_activity_type_id":16000000123,"start_date":"<start_date>","targetable_id":16000123456,"targetable_type":"Contact","title":"<title>"}`

### `freshsales_sales_activity_update`

Update Sales Activity · Write

Update an existing Freshsales sales activity, for example its outcome or notes.
Returns the updated sales activity. Only the fields you pass are changed.
Use freshsales_sales_activity_create to log a new activity.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `sales_activity_id` (`integer`, required): Numeric ID of the sales activity. Get it from freshsales_sales_activities_list. Example: 16000123456.
- `custom_field` (`object`, optional): Custom field values for the sales activity, keyed by the field's internal name (which starts with cf_). Example: {"cf_is_active": true, "cf_region": "EMEA"}.
- `end_date` (`string`, optional): End of the activity as an ISO 8601 datetime. Example: 2026-11-14T17:30:00+05:30.
- `location` (`string`, optional): Where the activity took place. Example: Acme HQ.
- `notes` (`string`, optional): Notes about the activity. Example: Interested in the annual plan.
- `owner_id` (`integer`, optional): ID of the Freshsales user who owns the sales activity. Get user IDs from freshsales_owners_list. Example: 16000012345.
- `sales_activity_outcome_id` (`integer`, optional): ID of the outcome. Get valid IDs from freshsales_selector_options_list with selector sales_activity_outcomes. Example: 16000000123.
- `sales_activity_type_id` (`integer`, optional): ID of the sales activity type (for example a call or meeting type). Get valid IDs from freshsales_selector_options_list with selector sales_activity_types. Example: 16000000123.
- `start_date` (`string`, optional): Start of the activity as an ISO 8601 datetime. Example: 2026-11-14T17:00:00+05:30.
- `targetable_id` (`integer`, optional): ID of the contact, account or deal the sales activity is linked to, matching targetable_type. Example: 16000123456.
- `targetable_type` (`string`, optional): Type of record the sales activity is linked to: Contact, SalesAccount (an account) or Deal. Example: Contact. One of: `Contact`, `SalesAccount`, `Deal`.
- `title` (`string`, optional): Title of the sales activity. Example: Discovery call with Jane.

Example input: `{"sales_activity_id":16000123456}`

### `freshsales_task_create`

Create Task · Write

Create a to-do task in Freshsales linked to a contact, account or deal and assigned to a user.
Returns the new task with its id and status.
Use freshsales_task_update to change or complete an existing task.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `due_date` (`string`, required): When the task is due, as an ISO 8601 datetime. Example: 2026-11-20T17:00:00Z.
- `owner_id` (`integer`, required): ID of the Freshsales user who owns the task. Get user IDs from freshsales_owners_list. Example: 16000012345.
- `targetable_id` (`integer`, required): ID of the contact, account or deal the task is linked to, matching targetable_type. Example: 16000123456.
- `targetable_type` (`string`, required): Type of record the task is linked to: Contact, SalesAccount (an account) or Deal. Example: Contact. One of: `Contact`, `SalesAccount`, `Deal`.
- `title` (`string`, required): Title of the task. Example: Send pricing proposal.
- `collaborator_ids` (`array`, optional): IDs of Freshsales users to add to the task as collaborators. Get user IDs from freshsales_owners_list. Example: [16000012346].
- `description` (`string`, optional): Details of the task. Example: Include the 50-seat volume discount.
- `outcome_id` (`integer`, optional): ID of the outcome. Get valid IDs from freshsales_selector_options_list with selector sales_activity_outcomes. Example: 16000000123.
- `task_type_id` (`integer`, optional): ID of the task type. Get valid IDs from freshsales_selector_options_list with selector sales_activity_types. Example: 16000000123.

Example input: `{"due_date":"<due_date>","owner_id":16000012345,"targetable_id":16000123456,"targetable_type":"Contact","title":"<title>"}`

### `freshsales_task_update`

Update Task · Write

Update an existing Freshsales task, or mark it complete by setting status to 1.
Returns the updated task. Only the fields you pass are changed.
Use freshsales_task_create to add a new task.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `task_id` (`integer`, required): Numeric ID of the task. Get it from freshsales_tasks_list. Example: 16000123456.
- `collaborator_ids` (`array`, optional): IDs of Freshsales users to add to the task as collaborators. Get user IDs from freshsales_owners_list. Example: [16000012346].
- `description` (`string`, optional): Details of the task. Example: Include the 50-seat volume discount.
- `due_date` (`string`, optional): When the task is due, as an ISO 8601 datetime. Example: 2026-11-20T17:00:00Z.
- `outcome_id` (`integer`, optional): ID of the outcome. Get valid IDs from freshsales_selector_options_list with selector sales_activity_outcomes. Example: 16000000123.
- `owner_id` (`integer`, optional): ID of the Freshsales user who owns the task. Get user IDs from freshsales_owners_list. Example: 16000012345.
- `status` (`integer`, optional): Task status: 0 = Open, 1 = Completed. Pass 1 to mark the task done. Example: 1. One of: `0`, `1`.
- `targetable_id` (`integer`, optional): ID of the contact, account or deal the task is linked to, matching targetable_type. Example: 16000123456.
- `targetable_type` (`string`, optional): Type of record the task is linked to: Contact, SalesAccount (an account) or Deal. Example: Contact. One of: `Contact`, `SalesAccount`, `Deal`.
- `task_type_id` (`integer`, optional): ID of the task type. Get valid IDs from freshsales_selector_options_list with selector sales_activity_types. Example: 16000000123.
- `title` (`string`, optional): Title of the task. Example: Send pricing proposal.

Example input: `{"task_id":16000123456}`

## Related

Other CRM & Sales connectors ([all 174](/agentkit/connectors/?category=crm-sales)):

- [Salesforce](/agentkit/connectors/salesforce/): Scalekit connector, OAuth, 74 tools
- [HubSpot](/agentkit/connectors/hubspot/): Scalekit connector, OAuth, 457 tools
- [Close](/agentkit/connectors/close/): Scalekit connector, OAuth, 103 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
