Freshsales
Manage leads, contacts, and deals in Freshsales CRM
Integrates Freshsales CRM into your workflow. List and create leads, contacts, and deals. Update existing leads. Supports all standard CRM operations for the Freshworks sales platform.
List leads from Freshsales CRM
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Freshsales API key |
domain | string | Yes | Your Freshsales domain (e.g. mycompany.myfreshworks.com) |
page | number | No | Page number for pagination |
perPage | number | No | Results per page (max 100) |
sort | string | No | Field to sort by (e.g. created_at) |
sortType | string | No | Sort direction: asc or desc |
| Parameter | Type | Description |
|---|
leads | json | Array of Freshsales lead objects |
metadata | json | Metadata: total pages |
Create a new lead in Freshsales CRM
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Freshsales API key |
domain | string | Yes | Your Freshsales domain (e.g. mycompany.myfreshworks.com) |
lastName | string | Yes | Lead last name |
firstName | string | No | Lead first name |
email | string | No | Lead email address |
mobile | string | No | Lead mobile number |
jobTitle | string | No | Lead job title |
company | string | No | Lead company name |
| Parameter | Type | Description |
|---|
lead | json | The created Freshsales lead object |
metadata | json | Lead metadata: id, created flag |
Update an existing lead in Freshsales CRM
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Freshsales API key |
domain | string | Yes | Your Freshsales domain (e.g. mycompany.myfreshworks.com) |
leadId | number | Yes | The Freshsales lead ID to update |
firstName | string | No | Updated first name |
lastName | string | No | Updated last name |
email | string | No | Updated email address |
mobile | string | No | Updated mobile number |
jobTitle | string | No | Updated job title |
company | string | No | Updated company name |
| Parameter | Type | Description |
|---|
lead | json | The updated Freshsales lead object |
metadata | json | Lead metadata: id, updated flag |
List contacts from Freshsales CRM
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Freshsales API key |
domain | string | Yes | Your Freshsales domain (e.g. mycompany.myfreshworks.com) |
page | number | No | Page number for pagination |
perPage | number | No | Results per page (max 100) |
| Parameter | Type | Description |
|---|
contacts | json | Array of Freshsales contact objects |
metadata | json | Metadata: total count |
List deals from Freshsales CRM
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Freshsales API key |
domain | string | Yes | Your Freshsales domain (e.g. mycompany.myfreshworks.com) |
page | number | No | Page number for pagination |
perPage | number | No | Results per page (max 100) |
sort | string | No | Field to sort by (e.g. created_at) |
sortType | string | No | Sort direction: asc or desc |
| Parameter | Type | Description |
|---|
deals | json | Array of Freshsales deal objects |
metadata | json | Metadata: total count |