Be the first to get access to new connectors. Get early access →
ConnectorBay Early access

Freshsales (BYOK) — connector documentation

  • MCP endpoint: https://byok-freshsales.connectorbay.com/mcp
  • REST API: POST https://byok-freshsales.connectorbay.com/v1/tools/{tool_name}, described by the OpenAPI 3.1 spec at https://byok-freshsales.connectorbay.com/openapi.json
  • Transport: Streamable HTTP, stateless, MCP specification 2025-06-18 or later
  • Authentication: your own Freshsales Freshworks CRM API key, sent in the X-Upstream-Key header of every request (never stored, logged or cached)
  • Health: https://byok-freshsales.connectorbay.com/health · Tool schemas: https://byok-freshsales.connectorbay.com/tools.json
  • Publisher: Unify Dynamics LLC · connectorbay.com/byok-freshsales · agent@connectorbay.com

What Freshsales (BYOK) is for

Freshsales (BYOK) lets an AI assistant read your own Freshsales data through the Freshsales API with a key you supply (Freshworks CRM API key). Read-only: 8 tools (list_contact_views, list_contacts_in_view, list_account_views, list_accounts_in_view, list_deal_views, list_deals_in_view, list_open_tasks, list_owners). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever sent to *.myfreshworks.com. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Freshsales. Freshsales and its logos are trademarks of their owners and are used only to say which service the connector works with.

Ask your assistant things like:

  • "What contact views exist in Freshsales?"
  • "Show the contacts in Freshsales view 4"
  • "What account views exist in Freshsales?"
  • "Show the accounts in Freshsales view 2"
  • "What deal views exist in Freshsales?"
  • "Show the open deals in Freshsales view 1"

What it does

  • list_contact_views: List the saved contact views (filters) of Freshsales; use a view id with list_contacts_in_view.
  • list_contacts_in_view: List the contacts of one saved Freshsales view (25 per page) with job title, email, phones, city, lead score and open deal amount.
  • list_account_views: List the saved account (company) views of Freshsales; use a view id with list_accounts_in_view.
  • list_accounts_in_view: List the accounts (companies) of one saved Freshsales view (25 per page) with location and open deal amount.
  • list_deal_views: List the saved deal views of Freshsales (for example Open Deals, My Deals); use a view id with list_deals_in_view.
  • list_deals_in_view: List the deals of one saved Freshsales view (25 per page) with amount, probability, expected close date and dates.
  • list_open_tasks: List the open Freshsales tasks with title, description, due date and owner id.
  • list_owners: List the users (owners) of the Freshsales account with their ids and names. Use the ids to read owner columns.

BYOK key

You bring your own Freshsales Freshworks CRM API key (https://crmsupport.freshworks.com/support/solutions/articles/50000002503-how-to-find-my-api-key-). Your assistant sends it in the X-Upstream-Key header with each request. ConnectorBay uses it for that one call only: it is never stored, logged or cached, never shown in an answer, and it is only sent to *.myfreshworks.com over https, with no redirects followed. Create a key with the fewest permissions the tools need (read-only if the provider offers it), and revoke it at the provider whenever you like.

Data sources

Live from the Freshsales API (*.myfreshworks.com) with a BYOK key; documentation: https://developers.freshworks.com/crm/api/. Endpoints checked against that documentation on 2026-10-16.

What it is not

Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Freshsales. Freshsales and its logos are trademarks of their owners and are used only to say which service the connector works with. It is read-only: it never creates, changes, sends or deletes anything in your Freshsales account.

Built for: Worldwide. Languages: English.