> For the complete documentation index, see [llms.txt](https://v2.dataos.info/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://v2.dataos.info/references/v1/resources/nilus/roles-and-permissions/salesforce-minimum-permissions.md).

# Salesforce

This page documents the minimum Salesforce org permissions a platform or Salesforce administrator must provision for Nilus to run batch pipelines against a Salesforce org. Salesforce is supported as a **batch read source only**.

## Pipeline modes supported

| Mode        | Supported |
| ----------- | --------- |
| Batch read  | Yes       |
| Batch write | No        |
| CDC         | No        |
| Metadata    | No        |

## Read data: Salesforce as source (`type: batch`)

Nilus uses this path when the depot is referenced in `source.address` of a pipeline config. Nilus queries records through the **Salesforce Bulk API** (`sf.bulk.<object>.query_all()`).

### Mandatory profile / permission set grants

| Permission                                               | Why required                                                         |
| -------------------------------------------------------- | -------------------------------------------------------------------- |
| **API Enabled**                                          | Without this, all API calls are rejected at the org level            |
| Object-level **Read** on each target object              | Required to query records via SOQL                                   |
| Field-level **Read** on all fields of each target object | The connector calls `.describe()` to enumerate and select all fields |

{% hint style="info" %}
Bulk API access is bundled with **API Enabled** on most Salesforce editions; no separate Bulk API permission is required.
{% endhint %}

### Object permissions reference

| Nilus `source_table` value | Salesforce object(s)     | Read required on                                         |
| -------------------------- | ------------------------ | -------------------------------------------------------- |
| `user`                     | `User`                   | User                                                     |
| `user_role`                | `UserRole`               | UserRole                                                 |
| `opportunity`              | `Opportunity`            | Opportunity                                              |
| `opportunity_line_item`    | `OpportunityLineItem`    | OpportunityLineItem                                      |
| `opportunity_contact_role` | `OpportunityContactRole` | OpportunityContactRole                                   |
| `account`                  | `Account`                | Account                                                  |
| `contact`                  | `Contact`                | Contact                                                  |
| `lead`                     | `Lead`                   | Lead                                                     |
| `campaign`                 | `Campaign`               | Campaign                                                 |
| `campaign_member`          | `CampaignMember`         | CampaignMember                                           |
| `product`                  | `Product2`               | Product2                                                 |
| `pricebook`                | `Pricebook2`             | Pricebook2                                               |
| `pricebook_entry`          | `PricebookEntry`         | PricebookEntry                                           |
| `task`                     | `Task`                   | Task                                                     |
| `event`                    | `Event`                  | Event                                                    |
| `custom:<ObjectApiName>`   | Custom object            | Read on the specific custom object + all required fields |

## Incremental strategies

| Object(s)                                                                                               | Strategy  | Incremental key         |
| ------------------------------------------------------------------------------------------------------- | --------- | ----------------------- |
| `user`, `user_role`, `contact`, `lead`, `campaign`, `product`, `pricebook`, `pricebook_entry`, `custom` | `replace` | — (full refresh always) |
| `opportunity`, `opportunity_line_item`, `opportunity_contact_role`, `campaign_member`, `task`, `event`  | `merge`   | `SystemModstamp`        |
| `account`                                                                                               | `merge`   | `LastModifiedDate`      |

## Permission matrix

| Use case             | API Enabled | Object-level Read | Field-level Read |
| -------------------- | ----------- | ----------------- | ---------------- |
| Read (source, batch) | Yes         | Yes               | Yes              |

## Notes

* Objects with strategy `replace` do not support incremental loading; they always perform a full refresh. Custom objects also default to `replace`.
* Salesforce is supported as a batch read source only. No write, CDC, or metadata grants apply.


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://v2.dataos.info/references/v1/resources/nilus/roles-and-permissions/salesforce-minimum-permissions.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.