Freshsales API

11 endpoints for Freshsales, each at its own method and path, called with your API key. Open an endpoint for its inputs, examples and response.

Base URL: https://cotlet.dev/api/v1/freshsales
Connects with: Your own Freshsales account (any user for deals, contacts, tasks and notes; admins set pipelines, staling age and Lost reasons)
Integration page: Freshsales

Read (7)

Return data and change nothing in the account.

Freshsales Endpoints: Read
Endpoint	Description
GET /deals	Deals from a Freshsales view, filtered by pipeline, stage or owner.
GET /deals/{deal_id}	One deal with its age, last activity, account and contacts.
GET /rotten-deals	Deals that are past the staling age of their pipeline.
GET /pipelines	Pipelines with their stages in order, and the Lost reasons.
GET /contacts	Contacts from a Freshsales view such as Never Contacted.
GET /contacts/{contact_id}	One contact with its account, open deals and latest notes.
GET /tasks	Your Freshsales tasks, filtered by status and by the deal or contact they belong to.

Change the account. Calls marked Confirm wait for the user to approve them.

Freshsales Endpoints: Write
Endpoint	Description
POST /tasks Confirm	Create a task on a contact, account or deal.
POST /tasks/{task_id}/complete	Mark a task completed, or open it again.
POST /notes Confirm	Add a note to a contact, account or deal.
PATCH /deals/{deal_id}/stage Confirm	Move a deal to another stage, including Won or Lost.