Freshsales REST API for managing contacts, accounts, deals, activities, and bulk jobs over HTTPS JSON endpoints. Base URL pattern: https://{bundleAlias}.myfreshworks.com/crm/sales/api/ (legacy: https://{subdomain}.freshsales.io/api/).
Changelog
4 versions
v2.0.1
Latest
- Output examples for every field of the Create/Get/Update Appointment, Contact, Deal and Task components.
v2.0.0
- (breaking change) MakeApiCall: headers and parameters changed to key-value array inputs per standard #1459 — existing flows that previously set these as JSON strings must migrate to the key-value editor. Body remains textarea/JSON.
v1.1.1
- add MakeApiCall component
v1.0.0
- Initial version
Authentication
| Type | Details |
|---|---|
| API Key |
Bundle Alias (text)
Your Freshsales bundle alias. Copy your bundle alias from your Profile settings page. For example: appmixer-944514646623155365.myfreshworks.com/crm/sales
API Key (text)
Log into your Freshsales account and find your API Key in Profile settings.
|
Actions
21
Create Deal
Create a new sales deal in Freshsales with optional contact, account, and custom field associations.
Create Task
Create a new task in Freshsales. Tasks can be associated with contacts, accounts, or deals.
Find Appointments
Find appointments with optional filters. Supports outputting as array, individual items, first item only, or CSV file.
Find Tasks
Find tasks with optional filters. Supports outputting as array, individual items, first item only, or CSV file.
Find Deals
Find deals by a specific view/filter. Returns a maximum of 100 deals per page. Supports outputting as array, individual items, first item only, or CSV file.
List Deal Views
Retrieves a list of all deal views available in Freshsales. Deal views are custom filtered views of deals. This component returns a maximum of 100 records per page.