Skip to content
For LLMsView as Markdown·

Freshsales ​

AI-powered CRM for managing contacts, leads, accounts, and deals.

DetailValue
CategoryCRM
Base URLhttps://{domain}.freshsales.io/api
AuthenticationBearer Token
Endpoints6
Connector keyfreshsales

Using Freshsales in a workflow ​

  1. Go to Connections and click New Connection.
  2. Pick Freshsales from the marketplace.
  3. Enter your credentials (see Authentication above for what's expected).
  4. In a workflow, drop an API Call node and select this connection.
  5. Pick the operation you need from the Operation dropdown. The full list is below.

Available endpoints ​

EndpointSummary
GET /contactsList contacts
POST /contactsCreate a contact
GET /contacts/{id}Get a contact
GET /leadsList leads
POST /leadsCreate a lead
GET /dealsList deals

Each endpoint is documented in full below. Use the outline on the right to jump to one.

GET /contacts ​

List contacts

DetailValue
Operation IDcrm.listContacts
MethodGET
Path/contacts

Parameters ​

NameLocationTypeRequired
pagequeryintegerNo

Using this endpoint in a workflow ​

  1. Add an API Call node to your workflow.
  2. Pick your Freshsales connection from the Connection dropdown.
  3. In the Operation dropdown, select crm.listContacts.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns ​

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Freshsales API reference.

POST /contacts ​

Create a contact

DetailValue
Operation IDcrm.createContact
MethodPOST
Path/contacts

Parameters ​

No parameters.

Request Body ​

FieldType
first_namestring
last_namestring
emailstring

Using this endpoint in a workflow ​

  1. Add an API Call node to your workflow.
  2. Pick your Freshsales connection from the Connection dropdown.
  3. In the Operation dropdown, select crm.createContact.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked: fill them or the call will fail at runtime.

What it returns ​

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Freshsales API reference.

GET /contacts/{id} ​

Get a contact

DetailValue
Operation IDcrm.getContact
MethodGET
Path/contacts/{id}

Parameters ​

NameLocationTypeRequired
idpathstringYes

Using this endpoint in a workflow ​

  1. Add an API Call node to your workflow.
  2. Pick your Freshsales connection from the Connection dropdown.
  3. In the Operation dropdown, select crm.getContact.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked: fill them or the call will fail at runtime.

What it returns ​

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Freshsales API reference.

GET /leads ​

List leads

DetailValue
Operation IDcrm.listLeads
MethodGET
Path/leads

Parameters ​

NameLocationTypeRequired
pagequeryintegerNo

Using this endpoint in a workflow ​

  1. Add an API Call node to your workflow.
  2. Pick your Freshsales connection from the Connection dropdown.
  3. In the Operation dropdown, select crm.listLeads.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns ​

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Freshsales API reference.

POST /leads ​

Create a lead

DetailValue
Operation IDcrm.createLead
MethodPOST
Path/leads

Parameters ​

No parameters.

Request Body ​

FieldType
first_namestring
last_namestring
emailstring

Using this endpoint in a workflow ​

  1. Add an API Call node to your workflow.
  2. Pick your Freshsales connection from the Connection dropdown.
  3. In the Operation dropdown, select crm.createLead.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked: fill them or the call will fail at runtime.

What it returns ​

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Freshsales API reference.

GET /deals ​

List deals

DetailValue
Operation IDcrm.listDeals
MethodGET
Path/deals

Parameters ​

No parameters.

Using this endpoint in a workflow ​

  1. Add an API Call node to your workflow.
  2. Pick your Freshsales connection from the Connection dropdown.
  3. In the Operation dropdown, select crm.listDeals.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns ​

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Freshsales API reference.