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

2 versions
v1.1.1 Latest
  • add MakeApiCall component
v1.0.0
  • Initial version

Authentication

TypeDetails
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 Appointment icon

Create Appointment

Create a new appointment and optionally link it to a related entity.
Create Contact icon

Create Contact

Create a new contact with optional account linkage and custom fields.
Create Deal icon

Create Deal

Create a new sales deal in Freshsales with optional contact, account, and custom field associations.
Delete Appointment icon

Delete Appointment

Delete an appointment by ID.
Create Task icon

Create Task

Create a new task in Freshsales. Tasks can be associated with contacts, accounts, or deals.
Delete Contact icon

Delete Contact

Delete a contact by ID.
Delete Deal icon

Delete Deal

Delete a deal by ID.
Delete Task icon

Delete Task

Delete a task by ID.
Find Appointments icon

Find Appointments

Find appointments with optional filters. Supports outputting as array, individual items, first item only, or CSV file.
Find Deals icon

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.
Find Tasks icon

Find Tasks

Find tasks with optional filters. Supports outputting as array, individual items, first item only, or CSV file.
Get Appointment icon

Get Appointment

Retrieve an appointment by ID.
Get Contact icon

Get Contact

Retrieve a contact by ID with optional embedded resources.
Get Deal icon

Get Deal

Retrieve a deal by ID with optional embedded resources.
Get Task icon

Get Task

Retrieve a task by ID.
List Deal Views icon

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.
Make Api Call icon

Make Api Call

Performs an arbitrary authorized API call to the Freshsales API.
Update Appointment icon

Update Appointment

Update an existing appointment by ID.
Update Contact icon

Update Contact

Update an existing contact by ID.
Update Deal icon

Update Deal

Update an existing deal by ID.
Update Task icon

Update Task

Update an existing task by ID.