# Salesforce full reference

> This is the full reference documentation for the Salesforce agent connector.

- Skill: `tools-only/salesforce-full-reference` (Agent Skill, multi-file: 3 files)
- Install (CLI): `npx skillmds@latest add tools-only/salesforce-full-reference`
- Raw SKILL.md: https://api.skillmd.com/api/skills/tools-only/salesforce-full-reference/raw
- Safety review: pending (external: skill-scanner PASS, skillspector PASS)
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Coding & Dev Tools
- Author: tools-only (https://skillmd.com/u/tools-only)
- Updated: 2026-09-29
- Page: https://skillmd.com/skills/tools-only/salesforce-full-reference

---

# Salesforce full reference

This is the full reference documentation for the Salesforce agent connector.

## Supported entities and actions

The Salesforce connector supports the following entities and actions.

| Entity | Actions |
|--------|---------|
| Sobjects | [List](#sobjects-list) |
| Accounts | [List](#accounts-list), [Get](#accounts-get), [API Search](#accounts-api-search), [Search](#accounts-search) |
| Contacts | [List](#contacts-list), [Get](#contacts-get), [API Search](#contacts-api-search), [Search](#contacts-search) |
| Leads | [List](#leads-list), [Get](#leads-get), [API Search](#leads-api-search), [Search](#leads-search) |
| Opportunities | [List](#opportunities-list), [Get](#opportunities-get), [API Search](#opportunities-api-search), [Search](#opportunities-search) |
| Tasks | [List](#tasks-list), [Get](#tasks-get), [API Search](#tasks-api-search), [Search](#tasks-search) |
| Events | [List](#events-list), [Get](#events-get), [API Search](#events-api-search) |
| Campaigns | [List](#campaigns-list), [Get](#campaigns-get), [API Search](#campaigns-api-search) |
| Cases | [List](#cases-list), [Get](#cases-get), [API Search](#cases-api-search) |
| Notes | [List](#notes-list), [Get](#notes-get), [API Search](#notes-api-search) |
| Content Versions | [List](#content-versions-list), [Get](#content-versions-get), [Download](#content-versions-download) |
| Attachments | [List](#attachments-list), [Get](#attachments-get), [Download](#attachments-download) |
| Query | [List](#query-list) |

## Sobjects

### Sobjects List

Returns a list of all available Salesforce objects (sObjects) in the organization.
This endpoint is used for health checks to verify authentication and connectivity.


#### Python SDK

```python
await salesforce.sobjects.list()
```

#### API

```bash
curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "sobjects",
    "action": "list"
}'
```



<details>
<summary><b>Response Schema</b></summary>

#### Records

| Field Name | Type | Description |
|------------|------|-------------|
| `name` | `string` |  |
| `label` | `null \| string` |  |
| `labelPlural` | `null \| string` |  |
| `keyPrefix` | `null \| string` |  |
| `custom` | `null \| boolean` |  |
| `queryable` | `null \| boolean` |  |
| `searchable` | `null \| boolean` |  |
| `createable` | `null \| boolean` |  |
| `updateable` | `null \| boolean` |  |
| `deletable` | `null \| boolean` |  |
| `urls` | `null \| object` |  |


</details>

## Accounts

### Accounts List

Returns a list of accounts via SOQL query. Default returns up to 200 records.
For pagination, check the response: if `done` is false, use `nextRecordsUrl` to fetch the next page.


#### Python SDK

```python
await salesforce.accounts.list(
    q="<str>"
)
```

#### API

```bash
curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "accounts",
    "action": "list",
    "params": {
        "q": "<str>"
    }
}'
```


#### Parameters

| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `q` | `string` | Yes | SOQL query for accounts. Default returns up to 200 records.
To change the limit, provide your own query with a LIMIT clause.
Example: "SELECT FIELDS(STANDARD) FROM Account ORDER BY LastModifiedDate DESC LIMIT 50"
 |


<details>
<summary><b>Response Schema</b></summary>

#### Records

| Field Name | Type | Description |
|------------|------|-------------|
| `Id` | `string` |  |
| `Name` | `string` |  |
| `attributes` | `object` |  |


#### Meta

| Field Name | Type | Description |
|------------|------|-------------|
| `done` | `boolean` |  |
| `nextRecordsUrl` | `string` |  |

</details>

### Accounts Get

Get a single account by ID. Returns all accessible fields by default.
Use the `fields` parameter to retrieve only specific fields for better performance.


#### Python SDK

```python
await salesforce.accounts.get(
    id="<str>"
)
```

#### API

```bash
curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "accounts",
    "action": "get",
    "params": {
        "id": "<str>"
    }
}'
```


#### Parameters

| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `id` | `string` | Yes | Salesforce Account ID (18-character ID starting with '001') |
| `fields` | `string` | No | Comma-separated list of fields to retrieve. If omitted, returns all accessible fields.
Example: "Id,Name,Industry,AnnualRevenue,Website"
 |


<details>
<summary><b>Response Schema</b></summary>

#### Records

| Field Name | Type | Description |
|------------|------|-------------|
| `Id` | `string` |  |
| `Name` | `string` |  |
| `attributes` | `object` |  |


</details>

### Accounts API Search

Search for accounts using SOSL (Salesforce Object Search Language).
SOSL is optimized for text-based searches across multiple fields and objects.
Use SOQL (list action) for structured queries with specific field conditions.


#### Python SDK

```python
await salesforce.accounts.api_search(
    q="<str>"
)
```

#### API

```bash
curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "accounts",
    "action": "api_search",
    "params": {
        "q": "<str>"
    }
}'
```


#### Parameters

| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `q` | `string` | Yes | SOSL search query. Format: FIND \{searchTerm\} IN scope RETURNING Object(fields) [LIMIT n]
Examples:
- "FIND \{Acme\} IN ALL FIELDS RETURNING Account(Id,Name)"
- "FIND \{tech*\} IN NAME FIELDS RETURNING Account(Id,Name,Industry) LIMIT 50"
- "FIND \{\"exact phrase\"\} RETURNING Account(Id,Name,Website)"
 |


<details>
<summary><b>Response Schema</b></summary>

#### Records

| Field Name | Type | Description |
|------------|------|-------------|
| `searchRecords` | `array<object>` |  |


</details>

### Accounts Search

Search and filter accounts records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

#### Python SDK

```python
await salesforce.accounts.search(
    query={"filter": {"eq": {"Id": "<str>"}}}
)
```

#### API

```bash
curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "accounts",
    "action": "search",
    "params": {
        "query": {"filter": {"eq": {"Id": "<str>"}}}
    }
}'
```

#### Parameters

| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `query` | `object` | Yes | Filter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or |
| `query.filter` | `object` | No | Filter conditions |
| `query.sort` | `array` | No | Sort conditions |
| `limit` | `integer` | No | Maximum results to return (default 1000) |
| `cursor` | `string` | No | Pagination cursor from previous response's `meta.cursor` |
| `fields` | `array` | No | Field paths to include in results |

#### Searchable Fields

| Field Name | Type | Description |
|------------|------|-------------|
| `Id` | `string` | Unique identifier for the account record |
| `Name` | `string` | Name of the account or company |
| `AccountSource` | `string` | Source of the account record (e.g., Web, Referral) |
| `BillingAddress` | `object` | Complete billing address as a compound field |
| `BillingCity` | `string` | City portion of the billing address |
| `BillingCountry` | `string` | Country portion of the billing address |
| `BillingPostalCode` | `string` | Postal code portion of the billing address |
| `BillingState` | `string` | State or province portion of the billing address |
| `BillingStreet` | `string` | Street address portion of the billing address |
| `CreatedById` | `string` | ID of the user who created this account |
| `CreatedDate` | `string` | Date and time when the account was created |
| `Description` | `string` | Text description of the account |
| `Industry` | `string` | Primary business industry of the account |
| `IsDeleted` | `boolean` | Whether the account has been moved to the Recycle Bin |
| `LastActivityDate` | `string` | Date of the last activity associated with this account |
| `LastModifiedById` | `string` | ID of the user who last modified this account |
| `LastModifiedDate` | `string` | Date and time when the account was last modified |
| `NumberOfEmployees` | `integer` | Number of employees at the account |
| `OwnerId` | `string` | ID of the user who owns this account |
| `ParentId` | `string` | ID of the parent account, if this is a subsidiary |
| `Phone` | `string` | Primary phone number for the account |
| `ShippingAddress` | `object` | Complete shipping address as a compound field |
| `ShippingCity` | `string` | City portion of the shipping address |
| `ShippingCountry` | `string` | Country portion of the shipping address |
| `ShippingPostalCode` | `string` | Postal code portion of the shipping address |
| `ShippingState` | `string` | State or province portion of the shipping address |
| `ShippingStreet` | `string` | Street address portion of the shipping address |
| `Type` | `string` | Type of account (e.g., Customer, Partner, Competitor) |
| `Website` | `string` | Website URL for the account |
| `SystemModstamp` | `string` | System timestamp when the record was last modified |

<details>
<summary><b>Response Schema</b></summary>

| Field Name | Type | Description |
|------------|------|-------------|
| `data` | `array` | List of matching records |
| `meta` | `object` | Pagination metadata |
| `meta.has_more` | `boolean` | Whether additional pages are available |
| `meta.cursor` | `string \| null` | Cursor for next page of results |
| `meta.took_ms` | `number \| null` | Query execution time in milliseconds |
| `data[].Id` | `string` | Unique identifier for the account record |
| `data[].Name` | `string` | Name of the account or company |
| `data[].AccountSource` | `string` | Source of the account record (e.g., Web, Referral) |
| `data[].BillingAddress` | `object` | Complete billing address as a compound field |
| `data[].BillingCity` | `string` | City portion of the billing address |
| `data[].BillingCountry` | `string` | Country portion of the billing address |
| `data[].BillingPostalCode` | `string` | Postal code portion of the billing address |
| `data[].BillingState` | `string` | State or province portion of the billing address |
| `data[].BillingStreet` | `string` | Street address portion of the billing address |
| `data[].CreatedById` | `string` | ID of the user who created this account |
| `data[].CreatedDate` | `string` | Date and time when the account was created |
| `data[].Description` | `string` | Text description of the account |
| `data[].Industry` | `string` | Primary business industry of the account |
| `data[].IsDeleted` | `boolean` | Whether the account has been moved to the Recycle Bin |
| `data[].LastActivityDate` | `string` | Date of the last activity associated with this account |
| `data[].LastModifiedById` | `string` | ID of the user who last modified this account |
| `data[].LastModifiedDate` | `string` | Date and time when the account was last modified |
| `data[].NumberOfEmployees` | `integer` | Number of employees at the account |
| `data[].OwnerId` | `string` | ID of the user who owns this account |
| `data[].ParentId` | `string` | ID of the parent account, if this is a subsidiary |
| `data[].Phone` | `string` | Primary phone number for the account |
| `data[].ShippingAddress` | `object` | Complete shipping address as a compound field |
| `data[].ShippingCity` | `string` | City portion of the shipping address |
| `data[].ShippingCountry` | `string` | Country portion of the shipping address |
| `data[].ShippingPostalCode` | `string` | Postal code portion of the shipping address |
| `data[].ShippingState` | `string` | State or province portion of the shipping address |
| `data[].ShippingStreet` | `string` | Street address portion of the shipping address |
| `data[].Type` | `string` | Type of account (e.g., Customer, Partner, Competitor) |
| `data[].Website` | `string` | Website URL for the account |
| `data[].SystemModstamp` | `string` | System timestamp when the record was last modified |

</details>

## Contacts

### Contacts List

Returns a list of contacts via SOQL query. Default returns up to 200 records.
For pagination, check the response: if `done` is false, use `nextRecordsUrl` to fetch the next page.


#### Python SDK

```python
await salesforce.contacts.list(
    q="<str>"
)
```

#### API

```bash
curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "contacts",
    "action": "list",
    "params": {
        "q": "<str>"
    }
}'
```


#### Parameters

| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `q` | `string` | Yes | SOQL query for contacts. Default returns up to 200 records.
To change the limit, provide your own query with a LIMIT clause.
Example: "SELECT FIELDS(STANDARD) FROM Contact WHERE AccountId = '001xx...' LIMIT 50"
 |


<details>
<summary><b>Response Schema</b></summary>

#### Records

| Field Name | Type | Description |
|------------|------|-------------|
| `Id` | `string` |  |
| `Name` | `string` |  |
| `attributes` | `object` |  |


#### Meta

| Field Name | Type | Description |
|------------|------|-------------|
| `done` | `boolean` |  |
| `nextRecordsUrl` | `string` |  |

</details>

### Contacts Get

Get a single contact by ID. Returns all accessible fields by default.
Use the `fields` parameter to retrieve only specific fields for better performance.


#### Python SDK

```python
await salesforce.contacts.get(
    id="<str>"
)
```

#### API

```bash
curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "contacts",
    "action": "get",
    "params": {
        "id": "<str>"
    }
}'
```


#### Parameters

| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `id` | `string` | Yes | Salesforce Contact ID (18-character ID starting with '003') |
| `fields` | `string` | No | Comma-separated list of fields to retrieve. If omitted, returns all accessible fields.
Example: "Id,FirstName,LastName,Email,Phone,AccountId"
 |


<details>
<summary><b>Response Schema</b></summary>

#### Records

| Field Name | Type | Description |
|------------|------|-------------|
| `Id` | `string` |  |
| `Name` | `string` |  |
| `attributes` | `object` |  |


</details>

### Contacts API Search

Search for contacts using SOSL (Salesforce Object Search Language).
SOSL is optimized for text-based searches across multiple fields.


#### Python SDK

```python
await salesforce.contacts.api_search(
    q="<str>"
)
```

#### API

```bash
curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "contacts",
    "action": "api_search",
    "params": {
        "q": "<str>"
    }
}'
```


#### Parameters

| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `q` | `string` | Yes | SOSL search query. Format: FIND \{searchTerm\} RETURNING Contact(fields) [LIMIT n]
Examples:
- "FIND \{John\} IN NAME FIELDS RETURNING Contact(Id,FirstName,LastName,Email)"
- "FIND \{*@example.com\} IN EMAIL FIELDS RETURNING Contact(Id,Name,Email) LIMIT 25"
 |


<details>
<summary><b>Response Schema</b></summary>

#### Records

| Field Name | Type | Description |
|------------|------|-------------|
| `searchRecords` | `array<object>` |  |


</details>

### Contacts Search

Search and filter contacts records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

#### Python SDK

```python
await salesforce.contacts.search(
    query={"filter": {"eq": {"Id": "<str>"}}}
)
```

#### API

```bash
curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "contacts",
    "action": "search",
    "params": {
        "query": {"filter": {"eq": {"Id": "<str>"}}}
    }
}'
```

#### Parameters

| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `query` | `object` | Yes | Filter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or |
| `query.filter` | `object` | No | Filter conditions |
| `query.sort` | `array` | No | Sort conditions |
| `limit` | `integer` | No | Maximum results to return (default 1000) |
| `cursor` | `string` | No | Pagination cursor from previous response's `meta.cursor` |
| `fields` | `array` | No | Field paths to include in results |

#### Searchable Fields

| Field Name | Type | Description |
|------------|------|-------------|
| `Id` | `string` | Unique identifier for the contact record |
| `AccountId` | `string` | ID of the account this contact is associated with |
| `CreatedById` | `string` | ID of the user who created this contact |
| `CreatedDate` | `string` | Date and time when the contact was created |
| `Department` | `string` | Department within the account where the contact works |
| `Email` | `string` | Email address of the contact |
| `FirstName` | `string` | First name of the contact |
| `IsDeleted` | `boolean` | Whether the contact has been moved to the Recycle Bin |
| `LastActivityDate` | `string` | Date of the last activity associated with this contact |
| `LastModifiedById` | `string` | ID of the user who last modified this contact |
| `LastModifiedDate` | `string` | Date and time when the contact was last modified |
| `LastName` | `string` | Last name of the contact |
| `LeadSource` | `string` | Source from which this contact originated |
| `MailingAddress` | `object` | Complete mailing address as a compound field |
| `MailingCity` | `string` | City portion of the mailing address |
| `MailingCountry` | `string` | Country portion of the mailing address |
| `MailingPostalCode` | `string` | Postal code portion of the mailing address |
| `MailingState` | `string` | State or province portion of the mailing address |
| `MailingStreet` | `string` | Street address portion of the mailing address |
| `MobilePhone` | `string` | Mobile phone number of the contact |
| `Name` | `string` | Full name of the contact (read-only, concatenation of first and last name) |
| `OwnerId` | `string` | ID of the user who owns this contact |
| `Phone` | `string` | Business phone number of the contact |
| `ReportsToId` | `string` | ID of the contact this contact reports to |
| `Title` | `string` | Job title of the contact |
| `SystemModstamp` | `string` | System timestamp when the record was last modified |

<details>
<summary><b>Response Schema</b></summary>

| Field Name | Type | Description |
|------------|------|-------------|
| `data` | `array` | List of matching records |
| `meta` | `object` | Pagination metadata |
| `meta.has_more` | `boolean` | Whether additional pages are available |
| `meta.cursor` | `string \| null` | Cursor for next page of results |
| `meta.took_ms` | `number \| null` | Query execution time in milliseconds |
| `data[].Id` | `string` | Unique identifier for the contact record |
| `data[].AccountId` | `string` | ID of the account this contact is associated with |
| `data[].CreatedById` | `string` | ID of the user who created this contact |
| `data[].CreatedDate` | `string` | Date and time when the contact was created |
| `data[].Department` | `string` | Department within the account where the contact works |
| `data[].Email` | `string` | Email address of the contact |
| `data[].FirstName` | `string` | First name of the contact |
| `data[].IsDeleted` | `boolean` | Whether the contact has been moved to the Recycle Bin |
| `data[].LastActivityDate` | `string` | Date of the last activity associated with this contact |
| `data[].LastModifiedById` | `string` | ID of the user who last modified this contact |
| `data[].LastModifiedDate` | `string` | Date and time when the contact was last modified |
| `data[].LastName` | `string` | Last name of the contact |
| `data[].LeadSource` | `string` | Source from which this contact originated |
| `data[].MailingAddress` | `object` | Complete mailing address as a compound field |
| `data[].MailingCity` | `string` | City portion of the mailing address |
| `data[].MailingCountry` | `string` | Country portion of the mailing address |
| `data[].MailingPostalCode` | `string` | Postal code portion of the mailing address |
| `data[].MailingState` | `string` | State or province portion of the mailing address |
| `data[].MailingStreet` | `string` | Street address portion of the mailing address |
| `data[].MobilePhone` | `string` | Mobile phone number of the contact |
| `data[].Name` | `string` | Full name of the contact (read-only, concatenation of first and last name) |
| `data[].OwnerId` | `string` | ID of the user who owns this contact |
| `data[].Phone` | `string` | Business phone number of the contact |
| `data[].ReportsToId` | `string` | ID of the contact this contact reports to |
| `data[].Title` | `string` | Job title of the contact |
| `data[].SystemModstamp` | `string` | System timestamp when the record was last modified |

</details>

## Leads

### Leads List

Returns a list of leads via SOQL query. Default returns up to 200 records.
For pagination, check the response: if `done` is false, use `nextRecordsUrl` to fetch the next page.


#### Python SDK

```python
await salesforce.leads.list(
    q="<str>"
)
```

#### API

```bash
curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "leads",
    "action": "list",
    "params": {
        "q": "<str>"
    }
}'
```


#### Parameters

| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `q` | `string` | Yes | SOQL query for leads. Default returns up to 200 records.
To change the limit, provide your own query with a LIMIT clause.
Example: "SELECT FIELDS(STANDARD) FROM Lead WHERE Status = 'Open' LIMIT 100"
 |


<details>
<summary><b>Response Schema</b></summary>

#### Records

| Field Name | Type | Description |
|------------|------|-------------|
| `Id` | `string` |  |
| `Name` | `string` |  |
| `attributes` | `object` |  |


#### Meta

| Field Name | Type | Description |
|------------|------|-------------|
| `done` | `boolean` |  |
| `nextRecordsUrl` | `string` |  |

</details>

### Leads Get

Get a single lead by ID. Returns all accessible fields by default.
Use the `fields` parameter to retrieve only specific fields for better performance.


#### Python SDK

```python
await salesforce.leads.get(
    id="<str>"
)
```

#### API

```bash
curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "leads",
    "action": "get",
    "params": {
        "id": "<str>"
    }
}'
```


#### Parameters

| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `id` | `string` | Yes | Salesforce Lead ID (18-character ID starting with '00Q') |
| `fields` | `string` | No | Comma-separated list of fields to retrieve. If omitted, returns all accessible fields.
Example: "Id,FirstName,LastName,Email,Company,Status,LeadSource"
 |


<details>
<summary><b>Response Schema</b></summary>

#### Records

| Field Name | Type | Description |
|------------|------|-------------|
| `Id` | `string` |  |
| `Name` | `string` |  |
| `attributes` | `object` |  |


</details>

### Leads API Search

Search for leads using SOSL (Salesforce Object Search Language).
SOSL is optimized for text-based searches across multiple fields.


#### Python SDK

```python
await salesforce.leads.api_search(
    q="<str>"
)
```

#### API

```bash
curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "leads",
    "action": "api_search",
    "params": {
        "q": "<str>"
    }
}'
```


#### Parameters

| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `q` | `string` | Yes | SOSL search query. Format: FIND \{searchTerm\} RETURNING Lead(fields) [LIMIT n]
Examples:
- "FIND \{Smith\} IN NAME FIELDS RETURNING Lead(Id,FirstName,LastName,Company,Status)"
- "FIND \{marketing\} IN ALL FIELDS RETURNING Lead(Id,Name,LeadSource) LIMIT 50"
 |


<details>
<summary><b>Response Schema</b></summary>

#### Records

| Field Name | Type | Description |
|------------|------|-------------|
| `searchRecords` | `array<object>` |  |


</details>

### Leads Search

Search and filter leads records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

#### Python SDK

```python
await salesforce.leads.search(
    query={"filter": {"eq": {"Id": "<str>"}}}
)
```

#### API

```bash
curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "leads",
    "action": "search",
    "params": {
        "query": {"filter": {"eq": {"Id": "<str>"}}}
    }
}'
```

#### Parameters

| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `query` | `object` | Yes | Filter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or |
| `query.filter` | `object` | No | Filter conditions |
| `query.sort` | `array` | No | Sort conditions |
| `limit` | `integer` | No | Maximum results to return (default 1000) |
| `cursor` | `string` | No | Pagination cursor from previous response's `meta.cursor` |
| `fields` | `array` | No | Field paths to include in results |

#### Searchable Fields

| Field Name | Type | Description |
|------------|------|-------------|
| `Id` | `string` | Unique identifier for the lead record |
| `Address` | `object` | Complete address as a compound field |
| `City` | `string` | City portion of the address |
| `Company` | `string` | Company or organization the lead works for |
| `ConvertedAccountId` | `string` | ID of the account created when lead was converted |
| `ConvertedContactId` | `string` | ID of the contact created when lead was converted |
| `ConvertedDate` | `string` | Date when the lead was converted |
| `ConvertedOpportunityId` | `string` | ID of the opportunity created when lead was converted |
| `Country` | `string` | Country portion of the address |
| `CreatedById` | `string` | ID of the user who created this lead |
| `CreatedDate` | `string` | Date and time when the lead was created |
| `Email` | `string` | Email address of the lead |
| `FirstName` | `string` | First name of the lead |
| `Industry` | `string` | Industry the lead's company operates in |
| `IsConverted` | `boolean` | Whether the lead has been converted to an account, contact, and opportunity |
| `IsDeleted` | `boolean` | Whether the lead has been moved to the Recycle Bin |
| `LastActivityDate` | `string` | Date of the last activity associated with this lead |
| `LastModifiedById` | `string` | ID of the user who last modified this lead |
| `LastModifiedDate` | `string` | Date and time when the lead was last modified |
| `LastName` | `string` | Last name of the lead |
| `LeadSource` | `string` | Source from which this lead originated |
| `MobilePhone` | `string` | Mobile phone number of the lead |
| `Name` | `string` | Full name of the lead (read-only, concatenation of first and last name) |
| `NumberOfEmployees` | `integer` | Number of employees at the lead's company |
| `OwnerId` | `string` | ID of the user who owns this lead |
| `Phone` | `string` | Phone number of the lead |
| `PostalCode` | `string` | Postal code portion of the address |
| `Rating` | `string` | Rating of the lead (e.g., Hot, Warm, Cold) |
| `State` | `string` | State or province portion of the address |
| `Status` | `string` | Current status of the lead in the sales process |
| `Street` | `string` | Street address portion of the address |
| `Title` | `string` | Job title of the lead |
| `Website` | `string` | Website URL for the lead's company |
| `SystemModstamp` | `string` | System timestamp when the record was last modified |

<details>
<summary><b>Response Schema</b></summary>

| Field Name | Type | Description |
|------------|------|-------------|
| `data` | `array` | List of matching records |
| `meta` | `object` | Pagination metadata |
| `meta.has_more` | `boolean` | Whether additional pages are available |
| `meta.cursor` | `string \| null` | Cursor for next page of results |
| `meta.took_ms` | `number \| null` | Query execution time in milliseconds |
| `data[].Id` | `string` | Unique identifier for the lead record |
| `data[].Address` | `object` | Complete address as a compound field |
| `data[].City` | `string` | City portion of the address |
| `data[].Company` | `string` | Company or organization the lead works for |
| `data[].ConvertedAccountId` | `string` | ID of the account created when lead was converted |
| `data[].ConvertedContactId` | `string` | ID of the contact created when lead was converted |
| `data[].ConvertedDate` | `string` | Date when the lead was converted |
| `data[].ConvertedOpportunityId` | `string` | ID of the opportunity created when lead was converted |
| `data[].Country` | `string` | Country portion of the address |
| `data[].CreatedById` | `string` | ID of the user who created this lead |
| `data[].CreatedDate` | `string` | Date and time when the lead was created |
| `data[].Email` | `string` | Email address of the lead |
| `data[].FirstName` | `string` | First name of the lead |
| `data[].Industry` | `string` | Industry the lead's company operates in |
| `data[].IsConverted` | `boolean` | Whether the lead has been converted to an account, contact, and opportunity |
| `data[].IsDeleted` | `boolean` | Whether the lead has been moved to the Recycle Bin |
| `data[].LastActivityDate` | `string` | Date of the last activity associated with this lead |
| `data[].LastModifiedById` | `string` | ID of the user who last modified this lead |
| `data[].LastModifiedDate` | `string` | Date and time when the lead was last modified |
| `data[].LastName` | `string` | Last name of the lead |
| `data[].LeadSource` | `string` | Source from which this lead originated |
| `data[].MobilePhone` | `string` | Mobile phone number of the lead |
| `data[].Name` | `string` | Full name of the lead (read-only, concatenation of first and last name) |
| `data[].NumberOfEmployees` | `integer` | Number of employees at the lead's company |
| `data[].OwnerId` | `string` | ID of the user who owns this lead |
| `data[].Phone` | `string` | Phone number of the lead |
| `data[].PostalCode` | `string` | Postal code portion of the address |
| `data[].Rating` | `string` | Rating of the lead (e.g., Hot, Warm, Cold) |
| `data[].State` | `string` | State or province portion of the address |
| `data[].Status` | `string` | Current status of the lead in the sales process |
| `data[].Street` | `string` | Street address portion of the address |
| `data[].Title` | `string` | Job title of the lead |
| `data[].Website` | `string` | Website URL for the lead's company |
| `data[].SystemModstamp` | `string` | System timestamp when the record was last modified |

</details>

## Opportunities

### Opportunities List

Returns a list of opportunities via SOQL query. Default returns up to 200 records.
For pagination, check the response: if `done` is false, use `nextRecordsUrl` to fetch the next page.


#### Python SDK

```python
await salesforce.opportunities.list(
    q="<str>"
)
```

#### API

```bash
curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "opportunities",
    "action": "list",
    "params": {
        "q": "<str>"
    }
}'
```


#### Parameters

| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `q` | `string` | Yes | SOQL query for opportunities. Default returns up to 200 records.
To change the limit, provide your own query with a LIMIT clause.
Example: "SELECT FIELDS(STANDARD) FROM Opportunity WHERE StageName = 'Closed Won' LIMIT 50"
 |


<details>
<summary><b>Response Schema</b></summary>

#### Records

| Field Name | Type | Description |
|------------|------|-------------|
| `Id` | `string` |  |
| `Name` | `string` |  |
| `attributes` | `object` |  |


#### Meta

| Field Name | Type | Description |
|------------|------|-------------|
| `done` | `boolean` |  |
| `nextRecordsUrl` | `string` |  |

</details>

### Opportunities Get

Get a single opportunity by ID. Returns all accessible fields by default.
Use the `fields` parameter to retrieve only specific fields for better performance.


#### Python SDK

```python
await salesforce.opportunities.get(
    id="<str>"
)
```

#### API

```bash
curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "opportunities",
    "action": "get",
    "params": {
        "id": "<str>"
    }
}'
```


#### Parameters

| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `id` | `string` | Yes | Salesforce Opportunity ID (18-character ID starting with '006') |
| `fields` | `string` | No | Comma-separated list of fields to retrieve. If omitted, returns all accessible fields.
Example: "Id,Name,Amount,StageName,CloseDate,AccountId"
 |


<details>
<summary><b>Response Schema</b></summary>

#### Records

| Field Name | Type | Description |
|------------|------|-------------|
| `Id` | `string` |  |
| `Name` | `string` |  |
| `attributes` | `object` |  |


</details>

### Opportunities API Search

Search for opportunities using SOSL (Salesforce Object Search Language).
SOSL is optimized for text-based searches across multiple fields.


#### Python SDK

```python
await salesforce.opportunities.api_search(
    q="<str>"
)
```

#### API

```bash
curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "opportunities",
    "action": "api_search",
    "params": {
        "q": "<str>"
    }
}'
```


#### Parameters

| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `q` | `string` | Yes | SOSL search query. Format: FIND \{searchTerm\} RETURNING Opportunity(fields) [LIMIT n]
Examples:
- "FIND \{Enterprise\} IN NAME FIELDS RETURNING Opportunity(Id,Name,Amount,StageName)"
- "FIND \{renewal\} IN ALL FIELDS RETURNING Opportunity(Id,Name,CloseDate) LIMIT 25"
 |


<details>
<summary><b>Response Schema</b></summary>

#### Records

| Field Name | Type | Description |
|------------|------|-------------|
| `searchRecords` | `array<object>` |  |


</details>

### Opportunities Search

Search and filter opportunities records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

#### Python SDK

```python
await salesforce.opportunities.search(
    query={"filter": {"eq": {"Id": "<str>"}}}
)
```

#### API

```bash
curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "opportunities",
    "action": "search",
    "params": {
        "query": {"filter": {"eq": {"Id": "<str>"}}}
    }
}'
```

#### Parameters

| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `query` | `object` | Yes | Filter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or |
| `query.filter` | `object` | No | Filter conditions |
| `query.sort` | `array` | No | Sort conditions |
| `limit` | `integer` | No | Maximum results to return (default 1000) |
| `cursor` | `string` | No | Pagination cursor from previous response's `meta.cursor` |
| `fields` | `array` | No | Field paths to include in results |

#### Searchable Fields

| Field Name | Type | Description |
|------------|------|-------------|
| `Id` | `string` | Unique identifier for the opportunity record |
| `AccountId` | `string` | ID of the account associated with this opportunity |
| `Amount` | `number` | Estimated total sale amount |
| `CampaignId` | `string` | ID of the campaign that generated this opportunity |
| `CloseDate` | `string` | Expected close date for the opportunity |
| `ContactId` | `string` | ID of the primary contact for this opportunity |
| `CreatedById` | `string` | ID of the user who created this opportunity |
| `CreatedDate` | `string` | Date and time when the opportunity was created |
| `Description` | `string` | Text description of the opportunity |
| `ExpectedRevenue` | `number` | Expected revenue based on amount and probability |
| `ForecastCategory` | `string` | Forecast category for this opportunity |
| `ForecastCategoryName` | `string` | Name of the forecast category |
| `IsClosed` | `boolean` | Whether the opportunity is closed |
| `IsDeleted` | `boolean` | Whether the opportunity has been moved to the Recycle Bin |
| `IsWon` | `boolean` | Whether the opportunity was won |
| `LastActivityDate` | `string` | Date of the last activity associated with this opportunity |
| `LastModifiedById` | `string` | ID of the user who last modified this opportunity |
| `LastModifiedDate` | `string` | Date and time when the opportunity was last modified |
| `LeadS

…(truncated)