Salesflare integration (Productivity, Marketing). Imported from open-connector.
https://api.salesflare.com/me
/accounts
| Param | Type | Required | Description |
|---|---|---|---|
| search | string | optional | Search text forwarded to Salesflare. |
| limit | integer | optional | The number of Salesflare records to return. |
| offset | integer | optional | The zero-based Salesflare result offset. |
| order_by | array | optional | Salesflare sort instructions, such as name or creation_date desc. |
| custom | string | optional | Salesflare custom filter expression. |
| details | boolean | optional | Whether Salesflare should include detailed account data. |
| name | string | optional | Filter accounts by name. |
| domain | array | optional | Account domains to filter by. |
| hotness | integer | optional | Salesflare hotness level: 1 room temp, 2 hot, or 3 on fire. |
/accounts
| Param | Type | Required | Description |
|---|---|---|---|
| owner | integer | optional | The ID of the user who owns the account. |
| name | string | optional | The account name. |
| domain | string | optional | The account domain. |
| picture | string | optional | The account logo URL. |
| size | number | optional | The account employee count. |
| website | string | optional | The account website URL. |
| description | string | optional | — |
| address | object | optional | The primary address of the account. |
| addresses | array | optional | Addresses associated with the account. |
| social_profiles | array | optional | Social profiles associated with the account. |
| phone_number | string | optional | — |
| string | optional | The account email address. | |
| tags | array | optional | Salesflare tag IDs or tag objects for the account. |
| custom | object | optional | Salesflare custom field values keyed by API field name. |
| raw | object | optional | Additional official Salesflare fields to merge into the request body. |
/accounts/{readId}
| Param | Type | Required | Description |
|---|---|---|---|
| id | integer | optional | The Salesflare account ID. |
| readId | string | required | Path parameter: readId |
/accounts/{readId}
| Param | Type | Required | Description |
|---|---|---|---|
| account_id | integer | required | The Salesflare account ID. |
| owner | integer | optional | The ID of the user who owns the account. |
| name | string | optional | The account name. |
| domain | string | optional | The account domain. |
| picture | string | optional | The account logo URL. |
| size | number | optional | The account employee count. |
| website | string | optional | The account website URL. |
| description | string | optional | — |
| address | object | optional | The primary address of the account. |
| addresses | array | optional | Addresses associated with the account. |
| social_profiles | array | optional | Social profiles associated with the account. |
| phone_number | string | optional | — |
| string | optional | The account email address. | |
| tags | array | optional | Salesflare tag IDs or tag objects for the account. |
| custom | object | optional | Salesflare custom field values keyed by API field name. |
| raw | object | optional | Additional official Salesflare fields to merge into the request body. |
| readId | string | required | Path parameter: readId |
/contacts
| Param | Type | Required | Description |
|---|---|---|---|
| search | string | optional | Search text forwarded to Salesflare. |
| limit | integer | optional | The number of Salesflare records to return. |
| offset | integer | optional | The zero-based Salesflare result offset. |
| order_by | array | optional | Salesflare sort instructions, such as name or creation_date desc. |
| custom | string | optional | Salesflare custom filter expression. |
| id | integer | optional | Filter contacts by Salesflare contact ID. |
| name | string | optional | Filter contacts by name. |
| string | optional | Filter contacts by email address. | |
| phone_number | string | optional | Filter contacts by phone number. |
| domain | string | optional | Filter contacts by domain. |
| account | integer | optional | Filter contacts by Salesflare account ID. |
| includeArchived | boolean | optional | Whether archived contacts should be included. |
| type | string | optional | Filter contacts by Salesflare contact type. |
/contacts
| Param | Type | Required | Description |
|---|---|---|---|
| owner | integer | optional | The ID of the user who owns the contact. |
| domain | string | optional | The contact domain. |
| string | optional | The contact email address. | |
| prefix | string | optional | The contact name prefix. |
| firstname | string | optional | The contact first name. |
| middle | string | optional | The contact middle name. |
| lastname | string | optional | The contact last name. |
| suffix | string | optional | The contact name suffix. |
| name | string | optional | The full name of the contact. |
| picture | string | optional | The contact profile picture URL. |
| birth_date | string | optional | The contact birth date. |
| phone_number | string | optional | — |
| home_phone_number | string | optional | — |
| work_phone_number | string | optional | — |
| mobile_phone_number | string | optional | — |
| description | string | optional | — |
| account | integer | optional | The ID of the Salesflare account linked to the contact. |
| address | object | optional | The primary address of the contact. |
| social_profiles | array | optional | Social profiles associated with the contact. |
| position | object | optional | The contact position details. |
| tags | array | optional | Salesflare tag IDs or tag objects for the contact. |
| custom | object | optional | Salesflare custom field values keyed by API field name. |
| raw | object | optional | Additional official Salesflare fields to merge into the request body. |
/contacts/{readId}
| Param | Type | Required | Description |
|---|---|---|---|
| id | integer | optional | The Salesflare contact ID. |
| readId | string | required | Path parameter: readId |
/contacts/{readId}
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | integer | required | The Salesflare contact ID. |
| owner | integer | optional | The ID of the user who owns the contact. |
| domain | string | optional | The contact domain. |
| string | optional | The contact email address. | |
| prefix | string | optional | The contact name prefix. |
| firstname | string | optional | The contact first name. |
| middle | string | optional | The contact middle name. |
| lastname | string | optional | The contact last name. |
| suffix | string | optional | The contact name suffix. |
| name | string | optional | The full name of the contact. |
| picture | string | optional | The contact profile picture URL. |
| birth_date | string | optional | The contact birth date. |
| phone_number | string | optional | — |
| home_phone_number | string | optional | — |
| work_phone_number | string | optional | — |
| mobile_phone_number | string | optional | — |
| description | string | optional | — |
| account | integer | optional | The ID of the Salesflare account linked to the contact. |
| address | object | optional | The primary address of the contact. |
| social_profiles | array | optional | Social profiles associated with the contact. |
| position | object | optional | The contact position details. |
| tags | array | optional | Salesflare tag IDs or tag objects for the contact. |
| custom | object | optional | Salesflare custom field values keyed by API field name. |
| raw | object | optional | Additional official Salesflare fields to merge into the request body. |
| readId | string | required | Path parameter: readId |
/opportunities
| Param | Type | Required | Description |
|---|---|---|---|
| search | string | optional | Search text forwarded to Salesflare. |
| limit | integer | optional | The number of Salesflare records to return. |
| offset | integer | optional | The zero-based Salesflare result offset. |
| order_by | array | optional | Salesflare sort instructions, such as name or creation_date desc. |
| custom | string | optional | Salesflare custom filter expression. |
| id | integer | optional | Filter opportunities by Salesflare opportunity ID. |
| name | string | optional | Filter opportunities by name. |
| status | string | optional | Filter opportunities by Salesflare status. |
| stage | integer | optional | Filter opportunities by Salesflare stage ID. |
| owner | integer | optional | Filter opportunities by owner user ID. |
| account | integer | optional | Filter opportunities by account ID. |
| min_value | number | optional | Minimum opportunity value. |
| max_value | number | optional | Maximum opportunity value. |
| closed | boolean | optional | Whether to return closed opportunities. |
| done | boolean | optional | Whether to return done opportunities. |
| hotness | integer | optional | Salesflare hotness level: 1 room temp, 2 hot, or 3 on fire. |
| details | boolean | optional | Whether Salesflare should include detailed opportunity data. |
/opportunities/{readId}
| Param | Type | Required | Description |
|---|---|---|---|
| id | integer | optional | The Salesflare opportunity ID. |
| readId | string | required | Path parameter: readId |
/opportunities
| Param | Type | Required | Description |
|---|---|---|---|
| owner | integer | optional | The ID of the user who owns the opportunity. |
| account | integer | optional | The ID of the Salesflare account linked to the opportunity. |
| stage | integer | optional | The Salesflare stage ID. |
| name | string | optional | The opportunity name. |
| value | number | optional | The opportunity value. |
| close_date | string | optional | The expected opportunity close date. |
| probability | number | optional | The opportunity probability. |
| description | string | optional | — |
| status | string | optional | The Salesflare opportunity status. |
| tags | array | optional | Salesflare tag IDs or tag objects for the opportunity. |
| custom | object | optional | Salesflare custom field values keyed by API field name. |
| raw | object | optional | Additional official Salesflare fields to merge into the request body. |
/opportunities/{readId}
| Param | Type | Required | Description |
|---|---|---|---|
| id | integer | required | The Salesflare opportunity ID. |
| owner | integer | optional | The ID of the user who owns the opportunity. |
| account | integer | optional | The ID of the Salesflare account linked to the opportunity. |
| stage | integer | optional | The Salesflare stage ID. |
| name | string | optional | The opportunity name. |
| value | number | optional | The opportunity value. |
| close_date | string | optional | The expected opportunity close date. |
| probability | number | optional | The opportunity probability. |
| description | string | optional | — |
| status | string | optional | The Salesflare opportunity status. |
| tags | array | optional | Salesflare tag IDs or tag objects for the opportunity. |
| custom | object | optional | Salesflare custom field values keyed by API field name. |
| raw | object | optional | Additional official Salesflare fields to merge into the request body. |
| readId | string | required | Path parameter: readId |
/tasks
| Param | Type | Required | Description |
|---|---|---|---|
| search | string | optional | Search text forwarded to Salesflare. |
| limit | integer | optional | The number of Salesflare records to return. |
| offset | integer | optional | The zero-based Salesflare result offset. |
| order_by | array | optional | Salesflare sort instructions, such as name or creation_date desc. |
| custom | string | optional | Salesflare custom filter expression. |
| id | integer | optional | Filter tasks by Salesflare task ID. |
| assignees | array | optional | User IDs assigned to the task. |
| type | string | optional | Filter tasks by Salesflare task type. |
| account | integer | optional | Filter tasks by account ID. |
/tasks
| Param | Type | Required | Description |
|---|---|---|---|
| account | integer | optional | The ID of the account linked to the task. |
| description | string | optional | The task description. |
| reminder_date | string | optional | The task due date. |
| assignees | array | optional | User IDs assigned to the task. |
| completed | boolean | optional | Whether the task is completed. |
| raw | object | optional | Additional official Salesflare fields to merge into the request body. |
/tasks/{readId}
| Param | Type | Required | Description |
|---|---|---|---|
| id | integer | required | The Salesflare task ID. |
| account | integer | optional | The ID of the account linked to the task. |
| description | string | optional | The task description. |
| reminder_date | string | optional | The task due date. |
| assignees | array | optional | User IDs assigned to the task. |
| completed | boolean | optional | Whether the task is completed. |
| raw | object | optional | Additional official Salesflare fields to merge into the request body. |
| readId | string | required | Path parameter: readId |