> For the complete documentation index, see [llms.txt](https://docs.valorx.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.valorx.com/valorx-wave/getting-started/get-started-with-valorx-wave/wave-embedded/salesforce-api-access-requirements.md).

# Salesforce API Access Requirements

A number of Wave Embedded features rely on Salesforce REST API calls to function. This page lists those features, explains what each one needs API access for, and walks through the setup required so they work correctly in your org.

{% hint style="warning" %}

#### Prerequisite

Review this page before configuring any of the features listed below. If API access or IP whitelisting is missing, these features will not work as expected, even when everything else is configured correctly.
{% endhint %}

## <mark style="color:violet;">Features That Require API Access</mark>

The following features rely on Salesforce REST API calls and are used during configuration by Designers and Admins.

### Designer and Admin Features

These features run when a Designer or Admin is configuring Wave, such as building a grid or setting up actions.

<table><thead><tr><th width="212">Feature</th><th>Why API Access Is Required</th></tr></thead><tbody><tr><td><a href="/pages/UsFQihu4PZCQRPDYnrW2">Grid Wizard</a> — Salesforce List Views</td><td>When an object is selected in the Grid Wizard, Wave fetches the details of the selected Salesforce List View to help set up the grid.</td></tr><tr><td><a href="/pages/dpA7ARK7AQZq812PglmQ#lookup">Lookup Filter Metadata</a></td><td>Wave retrieves lookup filter metadata through a REST API call.</td></tr><tr><td><a href="/pages/UsFQihu4PZCQRPDYnrW2#id-6.-actions">Actions Configuration Screen</a> — LWC Component List</td><td>Wave retrieves the list of available LWC components to display on the Row Action and Grid Action configuration screens.</td></tr><tr><td>Configured Location</td><td>Wave fetches and displays the configured location through a REST API call.</td></tr></tbody></table>

## <mark style="color:violet;">Requirements</mark>

For all of the features above to work correctly, both of the following must be in place.

### API Enabled Permission

The user must have the **API Enabled** permission in Salesforce. This is controlled at the Profile or Permission Set level.

To check or enable it as an Admin:

1. In Salesforce, go to **Setup**.
2. Under **Administration**, click **Users**, then open **Profiles** (or **Permission Sets**, if assigned that way).
3. Select the profile or permission set used by the affected users.
4. Under **System Permissions**, find **API Enabled**.
5. Click **Edit**, check the **API Enabled** box, and click **Save**.

### IP Restrictions, If Applicable

If the org has IP restrictions enabled, the Salesforce IP ranges applicable to the user's region must be added to the allow list. If this step is skipped, REST API calls will fail even when the user has API access.

To check whether your org restricts IPs:

1. In Salesforce, go to **Setup**.
2. Search for **Network Access** under **Security**.
3. If any ranges are listed under **Trusted IP Ranges**, your org is restricting access to those IPs only, and Salesforce's own IP ranges need to be added here as well.
4. Separately, check the affected user's **Profile** for a **Login IP Ranges** section. If ranges are listed there, the same addition needs to happen at the profile level.

To add the required Salesforce IP ranges:

1. Identify your Salesforce org instance (for example, NA1, EU2, AP1), found under **Company Information**.
2. Look up that instance's region using [status.salesforce.com](https://status.salesforce.com).
3. Get the matching IP ranges from either of the sources below.
4. Add those ranges to **Network Access** (org-wide) or the relevant **Profile's Login IP Ranges** (profile-level), depending on where the restriction is set.

Salesforce IP ranges can be found here:

* **Salesforce IP Ranges (JSON):** <https://ip-ranges.salesforce.com/ip-ranges.json>
* **Salesforce Help — Core Services IP Addresses and Domains to Allow:** <https://help.salesforce.com/s/articleView?id=000384438&type=1>

Once both requirements are met, all of the features listed above will function as expected.

## <mark style="color:violet;">Identifying the Correct IP Ranges to Whitelist</mark>

Use the steps below to find the right Salesforce IP ranges for your org.

1. Identify the Salesforce org instance (for example, NA1, EU2, AP1). This is found in Company Information.
2. Determine the region for that instance using [status.salesforce.com](https://status.salesforce.com).
3. Find the corresponding IP ranges using either the IP Ranges JSON or the Salesforce Help article linked above.

### Salesforce Region to IP Registry Mapping

Salesforce IP ranges are published by regional internet registries. Use this mapping to narrow down which ranges apply to your org.

<table><thead><tr><th width="148">Registry</th><th>Region Covered</th></tr></thead><tbody><tr><td>ARIN</td><td>North America — United States, Canada, and parts of the Caribbean</td></tr><tr><td>LACNIC</td><td>Latin America and the Caribbean — Brazil, Argentina, Mexico, and others</td></tr><tr><td>RIPE</td><td>Europe, the Middle East, and parts of Central Asia</td></tr><tr><td>APNIC</td><td>Asia-Pacific — India, Australia, Japan, Singapore, and others</td></tr></tbody></table>