# Freshsales
URL: https://docs.awellhealth.com/docs/marketplace/freshsales

> For the complete documentation index, see [llms.txt](https://docs.awellhealth.com/llms.txt).



<img src="/marketplace/freshsales.png" width="48" height="48" />

Freshsales is a cloud-based, AI-powered customer relationship management (CRM) software designed to help sales teams organize, manage, and close deals more efficiently.

Category: Customer Support. Adds 3 actions to a care flow.

## What to configure [#what-to-configure]

Set these once, on the extension in Awell Studio. An action fails at run time if a
required setting is missing.

| Setting           | Required | Notes                                                                         |
| ----------------- | -------- | ----------------------------------------------------------------------------- |
| API key           | Yes      | — Stored as a secret.                                                         |
| Freshsales domain | Yes      | Will be used to construct the API URL. E.g. https\://\<domain>.freshsales.io/ |

## Actions [#actions]

Freshsales adds these 3 actions to a care flow. Add one to a step, then fill in its inputs.

### Get lead [#get-lead]

Get a lead from Freshsales.

This action can be previewed in Studio before you publish.

| Input   | Type     | Required | Description               |
| ------- | -------- | -------- | ------------------------- |
| Lead ID | `string` | Yes      | The ID of the lead to get |

Returns:

| Data point     | Type        |
| -------------- | ----------- |
| `address`      | `string`    |
| `city`         | `string`    |
| `country`      | `string`    |
| `displayName`  | `string`    |
| `email`        | `string`    |
| `firstName`    | `string`    |
| `lastName`     | `string`    |
| `leadData`     | `json`      |
| `mobileNumber` | `telephone` |
| `state`        | `string`    |
| `timeZone`     | `string`    |
| `zipcode`      | `string`    |

### Search contact by email [#search-contact-by-email]

Search a contact by email from Freshsales.

This action can be previewed in Studio before you publish.

| Input | Type     | Required | Description                         |
| ----- | -------- | -------- | ----------------------------------- |
| Email | `string` | Yes      | The email of the lead to search for |

Returns:

| Data point     | Type        |
| -------------- | ----------- |
| `city`         | `string`    |
| `contactData`  | `json`      |
| `country`      | `string`    |
| `displayName`  | `string`    |
| `email`        | `string`    |
| `firstName`    | `string`    |
| `lastName`     | `string`    |
| `mobileNumber` | `telephone` |

### Search lead by email [#search-lead-by-email]

Search a lead by email from Freshsales.

This action can be previewed in Studio before you publish.

| Input | Type     | Required | Description                         |
| ----- | -------- | -------- | ----------------------------------- |
| Email | `string` | Yes      | The email of the lead to search for |

Returns:

| Data point     | Type        |
| -------------- | ----------- |
| `city`         | `string`    |
| `country`      | `string`    |
| `displayName`  | `string`    |
| `email`        | `string`    |
| `firstName`    | `string`    |
| `lastName`     | `string`    |
| `leadData`     | `json`      |
| `mobileNumber` | `telephone` |

## Setup and notes [#setup-and-notes]

Freshsales is a cloud-based, AI-powered customer relationship management (CRM) software designed to help sales teams organize, manage, and close deals more efficiently.

### Extension settings [#extension-settings]

To set up this extension, you will need to provide your Freshsales CRM domain and API key.

## Changelog [#changelog]

## CHANGELOG [#changelog-1]

## Where this page comes from [#where-this-page-comes-from]

The settings, actions, inputs, outputs and webhooks above are generated from the
extension's own code, at `@awell-health/awell-extensions` v2.1.159. They match what the
platform actually does rather than a description of it.

Field-level detail also appears in Awell Studio when you configure the action.
Something wrong or missing? Email [support@awellhealth.com](mailto:support@awellhealth.com).