Freshsales API Directory

Freshworks is a leading provider of AI-powered software solutions, dedicated to enhancing business operations across customer service, IT service management (ITSM), enterprise service management (ESM), and sales and marketing. By focusing on improving customer engagement and streamlining sales processes, Freshworks offers a suite of tools designed to automate marketing efforts and optimize IT service delivery. Their solutions are versatile, catering to businesses of all sizes and industries, making them a popular choice for organizations seeking to improve efficiency and customer satisfaction.

One of the standout offerings from Freshworks is Freshsales, a comprehensive sales CRM that empowers businesses to manage their sales processes effectively. With features like lead scoring, email tracking, and workflow automation, Freshsales helps sales teams close deals faster and more efficiently. The Freshsales API plays a crucial role in this ecosystem by allowing seamless integration with other tools and platforms, enabling businesses to customize and extend their CRM capabilities to suit their unique needs. This API integration process is vital for businesses looking to leverage Freshsales to its fullest potential.

Key highlights of Freshsales APIs

• Easy Data Access
  • Facilitates straightforward data integration with enterprise applications.
• Automation
  • Supports workflow automation to streamline operations.
• Custom Integration
  • Allows for tailored solutions to meet specific business needs.
• Real-Time Sync
  • Ensures up-to-date information across systems.
• Strong Security
  • Implements robust security measures for data protection.
• Scalable
  • Supports business growth without technical limitations.
• Developer-Friendly
  • Offers comprehensive documentation and support.
• Global Support
  • Provides assistance to businesses worldwide.
• Error Handling and Logging
  • Includes features for efficient troubleshooting.
• Rate Limiting
  • Ensures fair usage and prevents abuse.
• Version Control
  • Manages changes and updates effectively.
• Data Transformation
  • Enables data manipulation and formatting.
• Webhook Support
  • Allows for event-driven integrations and notifications.
• Detailed Analytics and Reporting
  • Offers insights through analytics and reporting.
• Sandbox Environment
  • Provides a testing environment for development.

Freshsales API Endpoints

Appointments

• POST https://domain.myfreshworks.com/crm/sales/api/appointments : Create an Appointment
• GET https://domain.myfreshworks.com/crm/sales/api/appointments/:appointment_id : View an Appointment
• DELETE https://domain.myfreshworks.com/crm/sales/api/appointments/[:appointment_id] : Delete an Appointment

Contacts

• POST https://domain.myfreshworks.com/crm/sales/api/contacts : Create a Contact
• DELETE https://domain.myfreshworks.com/crm/sales/api/contacts/[id] : Delete a Contact
• GET https://domain.myfreshworks.com/crm/sales/api/contacts/[id]/activities.json : List all Activities
• POST https://domain.myfreshworks.com/crm/sales/api/contacts/[id]/clone : Clone a Contact
• DELETE https://domain.myfreshworks.com/crm/sales/api/contacts/[id]/forget : Forget a Contact
• POST https://domain.myfreshworks.com/crm/sales/api/contacts/bulk_assign_owner : Bulk Assign Owner to Contacts
• POST https://domain.myfreshworks.com/crm/sales/api/contacts/bulk_destroy : Bulk Delete Contacts
• POST https://domain.myfreshworks.com/crm/sales/api/contacts/bulk_upsert : Bulk Upsert Contact
• GET https://domain.myfreshworks.com/crm/sales/api/contacts/lists/[id] : Fetch All Contacts from the List
• POST https://domain.myfreshworks.com/crm/sales/api/contacts/upsert : Upsert a Contact
• GET https://domain.myfreshworks.com/crm/sales/api/contacts/view/[view_id] : List All Contacts
• GET https://domain.myfreshworks.com/crm/sales/api/contacts/{id}/document_associations : List all Files and Links

CPQ Documents

• POST https://domain.myfreshworks.com/crm/sales/api/cpq/cpq_documents : Create a Document
• PUT https://domain.myfreshworks.com/crm/sales/api/cpq/cpq_documents/[id] : Update a Document
• DELETE https://domain.myfreshworks.com/crm/sales/api/cpq/cpq_documents/[id]/forget : Forget a Document
• GET https://domain.myfreshworks.com/crm/sales/api/cpq/cpq_documents/[id]/related_products : Get Related Products
• PUT https://domain.myfreshworks.com/crm/sales/api/cpq/cpq_documents/[id]/restore : Restore a Document
• PUT https://domain.myfreshworks.com/crm/sales/api/cpq/cpq_documents/[id]?include=products : Edit Products of the Document
• POST https://domain.myfreshworks.com/crm/sales/api/cpq/cpq_documents/cpq_documents_bulk_assign : Bulk-assign Owner to Documents
• POST https://domain.myfreshworks.com/crm/sales/api/cpq/cpq_documents/cpq_documents_bulk_delete : Bulk-delete Documents
• POST https://domain.myfreshworks.com/crm/sales/api/cpq/cpq_documents/cpq_documents_bulk_restore : Bulk-restore Documents
• PUT https://domain.myfreshworks.com/crm/sales/api/cpq/cpq_documents/cpq_documents_bulk_update : Bulk-update Documents

Products

• POST https://domain.myfreshworks.com/crm/sales/api/cpq/products : Create a Product
• DELETE https://domain.myfreshworks.com/crm/sales/api/cpq/products/[id] : Delete a Product
• PUT https://domain.myfreshworks.com/crm/sales/api/cpq/products/[id]/restore : Restore a Product
• PUT https://domain.myfreshworks.com/crm/sales/api/cpq/products/[id]?include=product_pricings : Delete Prices of the Product
• POST https://domain.myfreshworks.com/crm/sales/api/cpq/products/products_bulk_assign : Bulk-assign Owner to Products
• POST https://domain.myfreshworks.com/crm/sales/api/cpq/products/products_bulk_delete : Bulk-delete Products
• POST https://domain.myfreshworks.com/crm/sales/api/cpq/products/products_bulk_restore : Bulk-restore Products
• PUT https://domain.myfreshworks.com/crm/sales/api/cpq/products/products_bulk_update : Bulk-update Products

Custom Module

• POST https://domain.myfreshworks.com/crm/sales/api/custom_module/[entity_name] : Create a Record in Custom Module
• DELETE https://domain.myfreshworks.com/crm/sales/api/custom_module/[entity_name]/[id] : Delete a Record in Custom Module
• POST https://domain.myfreshworks.com/crm/sales/api/custom_module/[entity_name]/[id]/clone : Clone a Custom Module Record
• DELETE https://domain.myfreshworks.com/crm/sales/api/custom_module/[entity_name]/[id]/forget : Forget a Record in Custom Module
• POST https://domain.myfreshworks.com/crm/sales/api/custom_module/[entity_name]/bulk_destroy : Bulk-delete Records in Custom Module
• GET https://domain.myfreshworks.com/crm/sales/api/custom_module/[module_name]/view/[view_id] : Fetch Records from a Specific View in a Custom Module

Deals

• POST https://domain.myfreshworks.com/crm/sales/api/deals : Create a Deal
• PUT https://domain.myfreshworks.com/crm/sales/api/deals/[id] : Update a Deal
• POST https://domain.myfreshworks.com/crm/sales/api/deals/[id]/clone : Clone a Deal
• DELETE https://domain.myfreshworks.com/crm/sales/api/deals/[id]/forget : Forget a Deal
• PUT https://domain.myfreshworks.com/crm/sales/api/deals/[id]?include=products : Add Products to the Deal
• POST https://domain.myfreshworks.com/crm/sales/api/deals/bulk_destroy : Bulk Delete Deals
• POST https://domain.myfreshworks.com/crm/sales/api/deals/bulk_upsert : Bulk Upsert Deal
• POST https://domain.myfreshworks.com/crm/sales/api/deals/upsert : Upsert a Deal
• GET https://domain.myfreshworks.com/crm/sales/api/deals/view/[view_id] : List All Deals

Documents and Links

• POST https://domain.myfreshworks.com/crm/sales/api/document_links : Create a Link
• POST https://domain.myfreshworks.com/crm/sales/api/documents : Create a File

Job Status

• GET https://domain.myfreshworks.com/crm/sales/api/job_statuses/[id] : Job Status Tracking API

Marketing Lists

• GET https://domain.myfreshworks.com/crm/sales/api/lists : Fetch All Marketing Lists
• PUT https://domain.myfreshworks.com/crm/sales/api/lists/[id] : Update a Marketing List
• PUT https://domain.myfreshworks.com/crm/sales/api/lists/[list_id]/add_contacts : Copy Contacts to List
• PUT https://domain.myfreshworks.com/crm/sales/api/lists/[list_id]/move_contacts : Move Contacts from List
• PUT https://domain.myfreshworks.com/crm/sales/api/lists/[list_id]/remove_contacts : Remove Contacts From List

Lookup

• GET https://domain.myfreshworks.com/crm/sales/api/lookup : Lookup Search API

Notes

• POST https://domain.myfreshworks.com/crm/sales/api/notes : Create a Note
• DELETE https://domain.myfreshworks.com/crm/sales/api/notes/[id] : Delete a Note

Phone Calls

• POST https://domain.myfreshworks.com/crm/sales/api/phone_calls : Create a Manual Call Log

Sales Accounts

• POST https://domain.myfreshworks.com/crm/sales/api/sales_accounts : Create an Account
• GET https://domain.myfreshworks.com/crm/sales/api/sales_accounts/[id] : View an Account
• POST https://domain.myfreshworks.com/crm/sales/api/sales_accounts/[id]/clone : Clone an Account
• DELETE https://domain.myfreshworks.com/crm/sales/api/sales_accounts/[id]/forget : Forget an Account
• POST https://domain.myfreshworks.com/crm/sales/api/sales_accounts/bulk_destroy : Bulk Delete Accounts
• POST https://domain.myfreshworks.com/crm/sales/api/sales_accounts/bulk_upsert : Bulk Upsert Account
• POST https://domain.myfreshworks.com/crm/sales/api/sales_accounts/upsert : Upsert an Account
• GET https://domain.myfreshworks.com/crm/sales/api/sales_accounts/view/[view_id] : List All Accounts

Sales Activities

• GET https://domain.myfreshworks.com/crm/sales/api/sales_activities : List All Sales Activities
• GET https://domain.myfreshworks.com/crm/sales/api/sales_activities/[:sales_activity_id] : View a Sales Activity

Settings

• GET https://domain.myfreshworks.com/crm/sales/api/settings/:entity_type/forms : Get a list of all fields in a custom module
• GET https://domain.myfreshworks.com/crm/sales/api/settings/contacts/fields : List All Contact Fields
• GET https://domain.myfreshworks.com/crm/sales/api/settings/deals/fields : List All Deal Fields
• POST https://domain.myfreshworks.com/crm/sales/api/settings/module_customizations : Create Custom Modules
• GET https://domain.myfreshworks.com/crm/sales/api/settings/module_customizations/[id] : Get a list of custom modules
• GET https://domain.myfreshworks.com/crm/sales/api/settings/sales_accounts/fields : List All Account Fields
• GET https://domain.myfreshworks.com/crm/sales/api/settings/sales_activities/fields : List All Sales Activity Fields

Tasks

• GET https://domain.myfreshworks.com/crm/sales/api/tasks : List All Tasks
• DELETE https://domain.myfreshworks.com/crm/sales/api/tasks/[:task_id] : Delete Task
• GET https://domain.myfreshworks.com/crm/sales/api/tasks/[id] : View Task Details

‍

Freshsales API FAQs

How do I obtain an API key in Freshsales?

• Answer: To obtain your API key in Freshsales:some text
  1. Log in to your Freshsales account.
  2. Click on your profile picture in the top-right corner and select Profile Settings.
  3. Navigate to the API Settings tab.
  4. Your API key will be displayed under Your API key.
• Source: Freshsales API Documentation

What authentication method does the Freshsales API use?

• Answer: The Freshsales API uses token-based authentication. Include your API key in the Authorization header of your HTTP requests, formatted as Token token=YOUR_API_KEY.
• Source: Freshsales API Documentation

Are there rate limits for the Freshsales API?

• Answer: Yes, Freshsales enforces rate limits to ensure fair usage. The default limit is 1000 API requests per hour. Exceeding this limit will result in a 429 Too Many Requests response.
• Source: Freshsales API Rate Limits

Can I retrieve contact data using the Freshsales API?

• Answer: Yes, you can retrieve contact data by making a GET request to the /api/contacts endpoint. This will return a list of contacts and their details.
• Source: Freshsales API Documentation

Does the Freshsales API support webhooks?

• Answer: As of the latest available information, Freshsales does not natively support webhooks. However, you can use the API to poll for changes or integrate with third-party services that provide webhook functionality to achieve similar outcomes.
• Source: Freshsales API Documentation

Get Started with Freshsales API Integration

For quick and seamless integration with Freshsales API, Knit API offers a convenient solution. Our AI powered integration platform allows you to build any Freshsales API Integration use case. By integrating with Knit just once, you can integrate with multiple other CRMs, HRIS, Accounting, and other systems in one go with a unified approach. Knit takes care of all the authentication, authorization, and ongoing integration maintenance. This approach not only saves time but also ensures a smooth and reliable connection to Freshsales API.

To sign up for free, click here. To check the pricing, see our pricing page.

‍