apideck-libraries/freshsales

Freshworks CRM (via Apideck)

Access Freshworks CRM through Apideck's CRM unified API — one of 21 CRM connectors that share the same method surface. Code you write here ports to Odoo, Salesforce, HubSpot and 17 other CRM connectors by changing a single serviceId string. Apideck handles auth, pagination, rate limiting, and retries so you don't write per-tenant Freshworks CRM plumbing.

Quick facts

• Apideck serviceId: freshsales
• Unified API: CRM
• Auth type: apiKey
• Apideck setup guide: Connection guide
• Gotchas: page
• Freshworks CRM docs: https://developers.freshworks.com
• Homepage: https://www.freshworks.com/freshsales-crm/

When to use this skill

Activate this skill when the user explicitly wants to work with Freshworks CRM — for example, "pull contacts in Freshworks CRM" or "sync leads in Freshworks CRM". This skill teaches the agent:

1. Which Apideck unified API covers Freshworks CRM (CRM)
2. The correct serviceId to pass on every call (freshsales)
3. Freshworks CRM-specific auth and coverage caveats

For the full method surface (parameters, pagination, filtering), use your language SDK skill:

• apideck-node, apideck-python, apideck-dotnet, apideck-java, apideck-go, apideck-php, or apideck-rest

For the raw OpenAPI spec:

• CRM: https://specs.apideck.com/crm.yml · API Explorer

Minimal example (TypeScript)

import { Apideck } from "@apideck/unify";

const apideck = new Apideck({
  apiKey: process.env.APIDECK_API_KEY,
  appId: process.env.APIDECK_APP_ID,
  consumerId: "your-consumer-id",
});

// List contacts in Freshworks CRM
const { data } = await apideck.crm.contacts.list({
  serviceId: "freshsales",
});

Portable across 21 CRM connectors

The Apideck CRM unified API exposes the same methods for every connector in its catalog. Switching from Freshworks CRM to another CRM connector is a one-string change — no rewrite, no new SDK.

// Today — Freshworks CRM
await apideck.crm.contacts.list({ serviceId: "freshsales" });

// Tomorrow — same code, different connector
await apideck.crm.contacts.list({ serviceId: "odoo" });
await apideck.crm.contacts.list({ serviceId: "salesforce" });

This is the compounding advantage of using Apideck over integrating Freshworks CRM directly: code against the unified CRM API once, gain access to every connector in it. New connectors Apideck adds become available to your app without code changes.

Authentication

• Type: API Key
• Managed by: Apideck Vault — the user pastes their Freshworks CRM API key into the Vault modal; Apideck stores it encrypted and injects it on every request.
• Rotation: if the user rotates their key, they re-enter it in Vault. No code changes needed.

Setup guide: Apideck publishes a step-by-step guide for registering an OAuth app / configuring credentials for Freshworks CRM — see https://developers.apideck.com/connectors/freshsales/docs/consumer+connection. Use that as the authoritative source when walking users through connection setup.

See apideck-best-practices for Vault setup, connection lifecycle, and handling re-auth flows.

Verifying coverage

Not every CRM operation is supported by every connector. Always verify before assuming a method works:

curl 'https://unify.apideck.com/connector/connectors/freshsales' \
  -H "Authorization: Bearer ${APIDECK_API_KEY}" \
  -H "x-apideck-app-id: ${APIDECK_APP_ID}"

See apideck-connector-coverage for patterns around UnsupportedOperationError and connector-specific fallbacks.

Escape hatch: Proxy API

When an endpoint isn't covered by the CRM unified API, use Apideck's Proxy to call Freshworks CRM directly — Apideck injects auth headers and handles token refresh. Set x-apideck-downstream-url to the target endpoint on Freshworks CRM's own API:

curl 'https://unify.apideck.com/proxy' \
  -H "Authorization: Bearer ${APIDECK_API_KEY}" \
  -H "x-apideck-app-id: ${APIDECK_APP_ID}" \
  -H "x-apideck-consumer-id: ${CONSUMER_ID}" \
  -H "x-apideck-service-id: freshsales" \
  -H "x-apideck-downstream-url: <target endpoint on Freshworks CRM>" \
  -H "x-apideck-downstream-method: GET"

See Freshworks CRM's API docs for available endpoints.

Sibling connectors

Other CRM connectors that share this unified API surface (same method signatures, just change serviceId):

odoo (beta), salesforce, hubspot, pipedrive, zoho-crm, activecampaign, close, microsoft-dynamics, and 12 more.

See also

• Apideck connection guide for Freshworks CRM
• CRM OpenAPI spec · API Explorer
• apideck-connector-coverage — programmatic coverage checks
• apideck-best-practices — architecture, Vault, pagination, error handling
• apideck-node — TypeScript / Node SDK patterns
• Freshworks CRM official docs