> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/salesflare.md).

# Salesflare

Create and manage Salesflare CRM accounts, contacts, opportunities, and tasks.

## Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector  | Authentication |
| ---------- | -------------- |
| Salesflare | API Key        |

### Salesflare

Connect to Salesflare with an API key to manage CRM accounts and deals.

#### Set up in Salesflare

1. Prepare the Salesflare account or service that the workflow will access. Grant access to the required resources and operations.
2. **API Key:** Create an API key in Salesflare under Settings > API keys.

#### Set up in StackAI

1. Open **Settings → Connections**, add a connection, and select **Salesflare**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required | What to enter                                                                                                                                            |
| ------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| API Key       | Yes      | Create an API key in Salesflare under Settings > API keys. [Provider instructions](https://howto.salesflare.com/en/articles/1017460-do-you-have-an-api). |

### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

## Use an action

1. Add the required **Salesflare** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

## Actions

### List Accounts

Find Salesflare company accounts by ID, name, domain, or search text.

#### Inputs

| Field           | Type    | Required | Description                                                    |
| --------------- | ------- | -------- | -------------------------------------------------------------- |
| Account ID      | string  | No       | Return one account with this numeric ID.                       |
| Search          | string  | No       | Search account names and details.                              |
| Exact Name      | string  | No       | Filter by an exact account name.                               |
| Domain          | string  | No       | Filter by the company's internet domain.                       |
| Starting Offset | integer | No       | Start reading from this result offset. Minimum: 0. Default: 0. |
| Maximum Results | integer | No       | Maximum accounts to return. Minimum: 1. Default: 100.          |

#### Outputs

| Field       | Type          | Description                                               |
| ----------- | ------------- | --------------------------------------------------------- |
| Accounts    | object\_array | The matching Salesflare company accounts.                 |
| Next Offset | integer       | Offset for the next page, if more accounts are available. |

### Create Account

Create a company account in Salesflare.

#### Inputs

| Field          | Type            | Required | Description                                                                           |
| -------------- | --------------- | -------- | ------------------------------------------------------------------------------------- |
| Company Name   | string          | Yes      | Name of the company to create.                                                        |
| Company Domain | string          | No       | Company's internet domain for matching and enrichment.                                |
| Website        | string          | No       | Public website for the company.                                                       |
| Owner          | select (string) | No       | Salesflare teammate who owns this account. Options load from the selected connection. |
| Description    | textarea        | No       | Background information about the company.                                             |

#### Outputs

| Field   | Type   | Description                         |
| ------- | ------ | ----------------------------------- |
| Account | object | Created Salesflare company account. |

### List Contacts

Find Salesflare contacts by ID, name, email, account, or search text.

#### Inputs

| Field           | Type            | Required | Description                                                                             |
| --------------- | --------------- | -------- | --------------------------------------------------------------------------------------- |
| Search          | string          | No       | Search contact names, email addresses, and details.                                     |
| Maximum Results | integer         | No       | Maximum contacts to return. Minimum: 1. Default: 100.                                   |
| Contact ID      | integer         | No       | Return one contact with this numeric ID.                                                |
| Name            | string          | No       | Filter contacts by name.                                                                |
| Email           | string          | No       | Filter contacts by email address.                                                       |
| Account         | select (string) | No       | Only return contacts linked to this account. Options load from the selected connection. |
| Starting Offset | integer         | No       | Start reading from this result offset. Minimum: 0. Default: 0.                          |

#### Outputs

| Field       | Type          | Description                                       |
| ----------- | ------------- | ------------------------------------------------- |
| Contacts    | object\_array | Contacts that match the selected filters.         |
| Next Offset | integer       | Offset to pass back to continue listing contacts. |

### Create Contact

Create a person contact in Salesflare.

#### Inputs

| Field        | Type            | Required | Description                                                                           |
| ------------ | --------------- | -------- | ------------------------------------------------------------------------------------- |
| Email        | string          | Yes      | Primary email address for the contact.                                                |
| First Name   | string          | No       | Contact's first name.                                                                 |
| Last Name    | string          | No       | Contact's last name.                                                                  |
| Account      | select (string) | No       | Company account to link to this contact. Options load from the selected connection.   |
| Owner        | select (string) | No       | Salesflare teammate who owns this contact. Options load from the selected connection. |
| Phone Number | string          | No       | Primary phone number for the contact.                                                 |

#### Outputs

| Field   | Type   | Description                        |
| ------- | ------ | ---------------------------------- |
| Contact | object | Created Salesflare person contact. |

### List Opportunities

Find Salesflare opportunities by ID, name, account, pipeline, stage, or search text.

#### Inputs

| Field           | Type            | Required | Description                                                                            |
| --------------- | --------------- | -------- | -------------------------------------------------------------------------------------- |
| Opportunity ID  | string          | No       | Return one opportunity with this numeric ID.                                           |
| Search          | string          | No       | Search opportunity names and details.                                                  |
| Account         | select (string) | No       | Only return opportunities for this account. Options load from the selected connection. |
| Pipeline        | select (string) | No       | Only return opportunities in this pipeline. Options load from the selected connection. |
| Stage           | select (string) | No       | Only return opportunities in this stage. Options load from the selected connection.    |
| Starting Offset | integer         | No       | Start reading from this result offset. Minimum: 0. Default: 0.                         |
| Maximum Results | integer         | No       | Maximum opportunities to return. Minimum: 1. Default: 100.                             |

#### Outputs

| Field         | Type          | Description                                            |
| ------------- | ------------- | ------------------------------------------------------ |
| Opportunities | object\_array | Opportunities that match the selected filters.         |
| Next Offset   | integer       | Offset to pass back to continue listing opportunities. |

### Create Opportunity

Create a sales opportunity for a Salesflare account.

#### Inputs

| Field            | Type            | Required | Description                                                                                   |
| ---------------- | --------------- | -------- | --------------------------------------------------------------------------------------------- |
| Opportunity Name | string          | Yes      | Name of the deal or sales opportunity.                                                        |
| Account          | select (string) | Yes      | Company account this opportunity belongs to. Options load from the selected connection.       |
| Pipeline         | select (string) | Yes      | Sales pipeline containing the selected stage. Options load from the selected connection.      |
| Stage            | select (string) | Yes      | Initial pipeline stage for the opportunity. Options load from the selected connection.        |
| Value            | number          | No       | Expected monetary value of the opportunity.                                                   |
| Close Date       | date            | No       | Expected date when the opportunity will close.                                                |
| Owner            | select (string) | No       | Primary teammate responsible for this opportunity. Options load from the selected connection. |
| Assignee         | select (string) | No       | Teammate assigned to work on this opportunity. Options load from the selected connection.     |

#### Outputs

| Field       | Type   | Description                           |
| ----------- | ------ | ------------------------------------- |
| Opportunity | object | Created Salesflare sales opportunity. |

### Update Opportunity Stage

Move a Salesflare opportunity to another pipeline stage.

#### Inputs

| Field       | Type            | Required | Description                                                                           |
| ----------- | --------------- | -------- | ------------------------------------------------------------------------------------- |
| Opportunity | select (string) | Yes      | Opportunity to move to a new stage. Options load from the selected connection.        |
| Pipeline    | select (string) | Yes      | Pipeline containing the destination stage. Options load from the selected connection. |
| New Stage   | select (string) | Yes      | Destination stage for the opportunity. Options load from the selected connection.     |
| Close Date  | date            | No       | Expected close date when required by the destination stage.                           |

#### Outputs

| Field       | Type   | Description                                   |
| ----------- | ------ | --------------------------------------------- |
| Opportunity | object | Updated Salesflare opportunity and its stage. |

### List Tasks

Find Salesflare tasks by ID, account, assignee, or search text.

#### Inputs

| Field           | Type            | Required | Description                                                                             |
| --------------- | --------------- | -------- | --------------------------------------------------------------------------------------- |
| Task ID         | string          | No       | Return one task with this numeric ID.                                                   |
| Search          | string          | No       | Search task descriptions and details.                                                   |
| Account         | select (string) | No       | Only return tasks for this account. Options load from the selected connection.          |
| Assignee        | select (string) | No       | Only return tasks assigned to this teammate. Options load from the selected connection. |
| Starting Offset | integer         | No       | Start reading from this result offset. Minimum: 0. Default: 0.                          |
| Maximum Results | integer         | No       | Maximum tasks to return. Minimum: 1. Default: 100.                                      |

#### Outputs

| Field       | Type          | Description                                    |
| ----------- | ------------- | ---------------------------------------------- |
| Tasks       | object\_array | Tasks that match the selected filters.         |
| Next Offset | integer       | Offset to pass back to continue listing tasks. |

### Create Task

Create a follow-up task in Salesflare.

#### Inputs

| Field            | Type            | Required | Description                                                                       |
| ---------------- | --------------- | -------- | --------------------------------------------------------------------------------- |
| Task Description | textarea        | Yes      | What needs to be done.                                                            |
| Account          | select (string) | No       | Company account this task is about. Options load from the selected connection.    |
| Assignees        | string          | No       | Comma-separated teammate names, email addresses, or IDs responsible for the task. |
| Reminder Date    | datetime        | No       | When Salesflare should remind the assignees.                                      |

#### Outputs

| Field | Type   | Description                                     |
| ----- | ------ | ----------------------------------------------- |
| Task  | object | Created and verified Salesflare follow-up task. |

### List Pipelines

List Salesflare sales pipelines and their embedded stages.

#### Inputs

No input fields are required in this catalog entry.

#### Outputs

| Field     | Type          | Description                                 |
| --------- | ------------- | ------------------------------------------- |
| Pipelines | object\_array | Sales pipelines and their available stages. |

### List Stages

Find Salesflare opportunity stages by pipeline, ID, or name.

#### Inputs

| Field      | Type            | Required | Description                                                                     |
| ---------- | --------------- | -------- | ------------------------------------------------------------------------------- |
| Pipeline   | select (string) | No       | Only return stages in this pipeline. Options load from the selected connection. |
| Stage ID   | string          | No       | Return the stage with this numeric ID.                                          |
| Stage Name | string          | No       | Filter stages by name.                                                          |

#### Outputs

| Field  | Type          | Description                                   |
| ------ | ------------- | --------------------------------------------- |
| Stages | object\_array | Sales stages that match the selected filters. |

### List Users

Find enabled Salesflare teammates by ID, name, email, or search text.

#### Inputs

| Field           | Type    | Required | Description                                                    |
| --------------- | ------- | -------- | -------------------------------------------------------------- |
| User ID         | string  | No       | Return one enabled teammate with this numeric ID.              |
| Search          | string  | No       | Search enabled teammate names and details.                     |
| Email           | string  | No       | Filter by a teammate's email address.                          |
| Starting Offset | integer | No       | Start reading from this result offset. Minimum: 0. Default: 0. |
| Maximum Results | integer | No       | Maximum enabled teammates to return. Minimum: 1. Default: 100. |

#### Outputs

| Field       | Type          | Description                                            |
| ----------- | ------------- | ------------------------------------------------------ |
| Users       | object\_array | Enabled Salesflare teammates matching the filters.     |
| Next Offset | integer       | Offset for the next page, if more users are available. |

## Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/salesflare.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
