Freshsales

Read and write Freshsales contacts, accounts, deals, tasks, appointments, sales activities, notes and products with custom fields, plus upserts, views and field metadata.

Keep Freshsales contacts, deals and activities aligned with marketing, billing and support tools.

Build a flow with Freshsales Provider API documentation

Source actions

Destination actions

Data types

Validation status

Implemented · fixture tested.

Implementation is checked against provider-shaped fixtures for every action, authentication failures, rate limits, pagination and duplicate safety. Provider sandbox and authorised account validation are recorded separately when credential-backed runs are completed.

What you can map

appointments

Create appointment
Destination
Not retried automatically
Creates a appointment.
Get appointment
Source
One appointment.
List appointments
Source
Appointments visible to the API user.
Update appointment
Destination
Duplicate protected
Updates mapped appointment fields.

configuration

List configuration options
Source
Option lists such as deal pipelines, deal stages, lead sources, territories, contact statuses and sales activity types.

contacts lookup

Look up contacts by field
Source
Exact lookup of contacts by email or another field.

contacts

Create contact
Destination
Not retried automatically
Creates a contact with custom fields.
Get contact
Source
One contact with custom fields.
List contacts
Source
Contacts in a saved view, with custom fields.
Update contact
Destination
Duplicate protected
Updates mapped contact fields.
Upsert contact
Destination
Duplicate protected
Creates or updates a contact matched on id or a unique field (id, emails, mobile_number, external_id).

deals

Create deal
Destination
Not retried automatically
Creates a deal with custom fields.
Get deal
Source
One deal with custom fields.
List deals
Source
Deals in a saved view, with custom fields.
Update deal
Destination
Duplicate protected
Updates mapped deal fields.
Upsert deal
Destination
Duplicate protected
Creates or updates a deal matched on id or a unique field (id or a unique custom field).

fields

List fields
Source
Form fields for contacts, accounts, deals or sales activities, including custom fields and choices.

notes

Create note
Destination
Not retried automatically
Adds a note to a contact, account or deal.
Update note
Destination
Duplicate protected
Updates the text of a note.

products

Create product
Destination
Not retried automatically
Creates a product.
Get product
Source
One product.
Update product
Destination
Duplicate protected
Updates mapped product fields.

records

Search records
Source
Full-text search across contacts, accounts, deals and users.

sales accounts

Create account
Destination
Not retried automatically
Creates a account with custom fields.
Get account
Source
One account with custom fields.
List accounts
Source
Accounts in a saved view, with custom fields.
Update account
Destination
Duplicate protected
Updates mapped account fields.
Upsert account
Destination
Duplicate protected
Creates or updates a account matched on id or a unique field (id, name).

sales activities

Create sales activity
Destination
Not retried automatically
Creates a sales activity.
Get sales activity
Source
One sales activity.
List sales activities
Source
Sales activities visible to the API user.
Update sales activity
Destination
Duplicate protected
Updates mapped sales activity fields.

tasks

Create task
Destination
Not retried automatically
Creates a task.
Get task
Source
One task.
List tasks
Source
Tasks visible to the API user.
Update task
Destination
Duplicate protected
Updates mapped task fields.

users

List users
Source
Users (owners) in the Freshsales account.

views

List views
Source
Saved views (filters) for contacts, accounts or deals; use the ID with the list operations.

Authentication

Freshsales API key (Authorization: Token token=...)

Plans and access

All Freshsales (Freshworks CRM) plans include the REST API; CPQ products need plans with CPQ. The API key acts as its user and returns only records that user can access.

Test environment

Use a Freshsales trial account or a sandbox on Enterprise plans.

Rate limits

1,000 API requests per hour per account (higher on some plans); HTTP 429 when exceeded.

Provider events

Workflow automations can call webhooks on record events. Nexra event triggers are not yet available; flows run on demand or on a schedule.

Before you build a flow

Uses the myfreshworks.com/crm/sales API. Legacy *.freshsales.io accounts and freshworks.com aliases are not supported.
Contacts, accounts and deals are listed through saved views (List views provides the view IDs).
per_page is sent with the page size; Freshworks documents the default of 25 but not a maximum, so Nexra caps it at 100.
Contact subscription status, subscription types and do-not-disturb are returned read-only and never written.
Notes can be created and updated but Freshsales documents no notes list endpoint; products have no documented list endpoint.
Freshsales has no idempotency key; uncertain creates are not repeated automatically. Upserts converge on the unique identifier.
Deletes, forgets, clones, bulk jobs and marketing list membership changes are not automated.