What we do
Tools
Industries
Department
How we workLet's talk →
Home/Freshsales
Freshsales developer API

Freshsales API: Your Login Address Picks the Base URL, Your Profile Holds the Key

The deal went to Won an hour ago and the equipment still isn't reserved, because the only link between Freshsales and the reservation system is a rep with two tabs open. The Freshsales REST API can close that gap, and one header gets you in. First, though, check which Freshsales you're on. The address you log in at decides the base URL, and a script written for one version won't reach the other.

Where Freshsales stops

It runs the pipeline well, but a closed deal triggers nothing in your other systems, so it just sits there waiting for someone.

Stuck on Freshsales? Let's solve it →
Your first Freshsales API request

Key: open your profile, then the API Settings tab, and copy Your API key. Each user has their own, and calls see only what that user is allowed to see.

Profile picture Profile Settings API Settings

Header: Authorization: Token token=YOUR_KEY, plus Content-Type: application/json.

Address: on current Freshsales, the bundle alias shown under your key, then /crm/sales/api/, for example https://yourcompany.myfreshworks.com/crm/sales/api/contacts/ID. On Classic, https://yourcompany.freshsales.io/api/.

Limit: the API reference gives 1,000 requests per hour per account. Go past it and calls return HTTP 429.

The current Freshsales API next to the Classic one

Current Freshsales

Logins at myfreshworks.com

  • Requests go to your bundle alias plus /crm/sales/api/.
  • The bundle alias, listed under the API key, picks which CRM account in your Freshworks organization a call reaches.
  • On Zapier, this is the Freshsales Suite app.
Freshsales Classic

Logins at freshsales.io

  • Requests go to yourcompany.freshsales.io/api/.
  • Same Token token= header, and its reference states the same 1,000 requests an hour.
  • On Zapier, this is the separate Freshsales Classic app.

A correct key sent to the other version's address still fails, so match the URL to your login before you debug anything else.

Equipment rental: when Won started reserving the gear

A regional equipment rental company with eight reps on Freshsales, a separate scheduling and reservation system for the equipment, and invoicing in QuickBooks.

Before

A rep closed a rental in Freshsales, switched to the reservation system to block the dates, then opened QuickBooks to build the invoice from what they remembered quoting.

When dates or prices drifted between the three systems, nobody noticed until the customer called about an invoice that didn't match.

After

Marking the deal Won now reserves the equipment for the dates on the deal record, creates the QuickBooks invoice at the agreed price and sends the customer a confirmation.

Reps stay on calls instead of reconciling the same numbers across three apps.

Freshsales API scripts that pass a test and fail in real use

A create call that doubles contacts

How you'll know: The same person shows up twice after a form submission and an import.

Fix: Use POST /api/contacts/upsert with a unique_identifier such as emails (the older email attribute isn't accepted for this). It updates a match with a 200 or creates with a 201, and when it finds duplicates it returns their IDs to merge rather than guessing.

Every job running on one admin's key

How you'll know: Every record shows that admin as its creator, and the integration depends on one person's account and role.

Fix: Keys are per user and carry that user's access. Give the integration its own user with the role the job needs, and keep its key in the server's secret store.

A bulk load that stalls halfway

How you'll know: A big import starts returning 429s and the rest of the rows never arrive.

Fix: Send records through bulk upsert, which takes up to 100 per request with no more than 10 bulk jobs in progress at once, and pace everything else against the hourly limit.

Search used where an exact match was needed

How you'll know: A lookup by email returns the wrong record, or several.

Fix: Use /api/lookup with f=email, or filtered search, which only return exact matches. /api/search is the broad one: 10 results by default, 100 at most per page.

Freshsales the product, and the API behind it

What is Freshsales?

Freshworks' sales CRM: a deal pipeline, built-in phone and email, lead scoring and workflow automation, designed to get a sales team running fast. It's sold alone or with Freshworks' marketing tools as Freshsales Suite, and older accounts still run Freshsales Classic.

Is Freshsales the same as Freshdesk?

No. Freshdesk is Freshworks' help desk for support teams and Freshsales is its CRM. Same company, separate products, each with its own API. Joining the two is a separate job, covered on our Freshsales and Freshdesk page.

How much does Freshsales cost?

There's a free plan for small teams and per-user monthly tiers above it, adding automation, reporting and AI features. Freshworks changes prices and what sits in each tier, so take the figures from its pricing page for the plan you're considering.

Is Freshsales better than HubSpot?

For a small sales team that wants a CRM running quickly at a lower per-seat cost, Freshsales is often the easier fit. HubSpot goes further once its marketing and service hubs are added, and costs more. Our Freshsales vs. HubSpot page sets out the trade, and the API work on either is much the same.

Does Freshsales have a mobile app?

Yes, for iOS and Android, covering the pipeline, contacts, calls and deal updates. A deal a rep moves on the phone is saved to the same records the API reads, so an integration sees it like any other change.

Where do I log into Freshsales?

Current accounts log in at a myfreshworks.com address, such as yourcompany.myfreshworks.com, or through the Freshworks login page. Freshsales Classic accounts use yourcompany.freshsales.io. That address also tells you which API base URL to use.

Who builds integrations on the Freshsales API?

Any developer comfortable with REST can make the first call. The longer work is the logic around it. At n-frames we build these as small services that run on a dedicated integration user's key, page through results under the hourly limit, and write back with upserts so nothing doubles.

Let's talk

Tell us the one thing your team does manually that eats up time. We read every message and reply within a day.