freshsales · diff
v1.0.0 to v1.0.0
4 added, 0 removed. Audit A to A.
---
name: freshsales
description: |
Freshworks CRM integration via Apideck's CRM unified API — same methods work across every connector in CRM, switch by changing `serviceId`. Use when the user wants to read, write, or search contacts, companies, leads, opportunities, activities, and pipelines in Freshworks CRM. Routes through Apideck with serviceId "freshsales".
license: Apache-2.0
alwaysApply: false
metadata:
author: apideck
version: "1.0.0"
serviceId: freshsales
unifiedApis: ["crm"]
authType: apiKey
tier: "2"
verified: true
---
# 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](https://developers.apideck.com/connectors/freshsales/docs/consumer+connection)
- **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`](../../skills/apideck-node/), [`apideck-python`](../../skills/apideck-python/), [`apideck-dotnet`](../../skills/apideck-dotnet/), [`apideck-java`](../../skills/apideck-java/), [`apideck-go`](../../skills/apideck-go/), [`apideck-php`](../../skills/apideck-php/), or [`apideck-rest`](../../skills/apideck-rest/)
For the raw OpenAPI spec:
- **CRM:** [https://specs.apideck.com/crm.yml](https://specs.apideck.com/crm.yml) · [API Explorer](https://developers.apideck.com/api-explorer?id=crm)
## Minimal example (TypeScript)
```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.
```typescript
// 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](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`](../../skills/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:
```bash
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`](../../skills/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:
```bash
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](https://developers.freshworks.com) for available endpoints.
## Sibling connectors
Other **CRM** connectors that share this unified API surface (same method signatures, just change `serviceId`):
[`odoo`](../odoo/) *(beta)*, [`salesforce`](../salesforce/), [`hubspot`](../hubspot/), [`pipedrive`](../pipedrive/), [`zoho-crm`](../zoho-crm/), [`activecampaign`](../activecampaign/), [`close`](../close/), [`microsoft-dynamics`](../microsoft-dynamics/), and 12 more.
## See also
+ - [Apideck connection guide for Freshworks CRM](https://developers.apideck.com/connectors/freshsales/docs/consumer+connection)
- [CRM OpenAPI spec](https://specs.apideck.com/crm.yml) · [API Explorer](https://developers.apideck.com/api-explorer?id=crm)
- [`apideck-connector-coverage`](../../skills/apideck-connector-coverage/) — programmatic coverage checks
- [`apideck-best-practices`](../../skills/apideck-best-practices/) — architecture, Vault, pagination, error handling
- [`apideck-node`](../../skills/apideck-node/) — TypeScript / Node SDK patterns
- [Freshworks CRM official docs](https://developers.freshworks.com)