Microsoft Lists Setup Guide

Follow our setup guide to connect Microsoft Lists to Fivetran.

Prerequisites

To connect Microsoft Lists to Fivetran, you need:

A SharePoint account
A SharePoint Site containing lists
The ability to grant Fivetran permission to read from this account
The SharePoint account used for authorizing the connection, needs read-access to the top-level SharePoint site or Hub site

Supported authentication methods

You can use one of the following authentication methods to connect your Microsoft lists account to Fivetran:

Quick setup: This method uses OAuth to authenticate your connection. You authorize Fivetran directly through Microsoft and select lists from a dropdown or manually enter the SharePoint site you want to connect.
Advanced setup: This method uses a registered Azure AD app to grant more granular access control. You provide the tenant ID, client ID, and client Secret, along with the site ID of the SharePoint site you want to connect.

Setup instructions

Find site ID

Perform the following steps to find the site ID of the site(s) you want to connect to Fivetran.

Only perform these steps if you want to manually enter the site ID while using our Quick setup authentication or if you want to authenticate using our Advanced setup; otherwise, skip to Finish Fivetran configuration.

Fetch site collection ID

Log in to your SharePoint account and navigate to the site that you want to connect to Fivetran.
Once you are on the site's home page, find the URL in your browser's address bar and append /_api/site/id to the end of the site URL. For example, https://<tenant>.sharepoint.com/sites/<site-name>/_api/site/id.
Click enter to open the URL. The browser displays a JSON response containing information about the SharePoint site.
Make a note of the site collection ID.

Fetch site ID

Sign in to Microsoft Graph Explorer with an account that has a SharePoint Administrator or higher role.
Make a GET request to the https://graph.microsoft.com/v1.0/sites/{siteCollectionId} endpoint in the Graph Explorer. Replace {siteCollectionId} with the ID you found in Step 1.1. The response returns an id field in the format {hostname},{siteCollectionId},{siteId}.
Make a note of the site ID.

Fetch sub-site ID (optional)

If you want to connect Fivetran to a sub-site rather than the root site, make a GET request to the https://graph.microsoft.com/v1.0/sites/{site_id}/sites endpoint using the site ID from Step 1.2. The response returns the IDs of all the sub-sites available for the site.

Get the sub Site ID

Configure SharePoint access (For Advanced setup only)

Expand for instructions

Decide how you want Fivetran to access your SharePoint site. You can configure the connection in different ways depending on your permission levels within Microsoft.

You can create and configure your own Azure app in Microsoft Entra ID to authenticate with Fivetran. This method can be reused across multiple Fivetran connections and offers more granular access control.

Register your app

You must perform these steps only once for each SharePoint tenant.

In the Azure Portal, go to Microsoft Entra ID > App registrations > New registration.
Enter a Name for your application. You will need the application name while configuring the connection.
Select Accounts in this organizational directory only as the supported account types and click Register.
In the new app’s Overview page, make a note of the Application (client) ID and Directory (tenant) ID. You will need them to configure Fivetran.
Go to Certificates & secrets > New client secret and make a note of the secret value. You will need it to configure Fivetran.
Navigate to API Permissions > Add a permission > Microsoft Graph.
Select the required Application permissions.
Select Sites.Selected and click Add permissions.
Click Grant admin consent to apply the permissions.

Grant access for a selected site to the SharePoint app

You must perform these steps only once for each SharePoint site.

Sign in to Microsoft Graph Explorer with an account that has a SharePoint Administrator or higher role.
In Graph Explorer, on the top right, click your avatar.
Select Consent to permissions and then choose Consent for Sites.FullControl.All to provide the Graph Explorer tool the ability to modify site permissions for your tenant.
Make a POST request to the endpoint https://graph.microsoft.com/v1.0/sites/{site_id}/permissions with Request Header Content-Type: application/json and Request Body:
```
{
"roles": ["read"],
"grantedToIdentities": [
{
"application": {
"id": "<application_client_id>",
"displayName": "<application_name>"
}
}
]
}
```
Replace {site_id}, {application_client_id}, and {application_name} from the steps above.

Once you have granted access to the site, allow up to a minute for the changes to reflect in the SharePoint app.

Finish Fivetran configuration

In the connection setup form, enter your chosen Destination schema name.
In the Destination names section, select Fivetran naming or Source naming.
In the Authentication method field, select Quick setup or Advance setup.
If you selected Quick setup:
i. Click Authorize.
ii. Set the Use Input Field for Site toggle to choose how you want to specify the SharePoint site. Set it to ON to manually enter the site using the format {hostname},{siteCollectionId},{siteId} in the text input field that appears. Set it to OFF to select the SharePoint site from the available list using the Sync Lists from Site drop-down menu.
If you want to sync data for a site, you can enter either the site collection ({siteCollectionId}) or the full site ID ({hostname},{siteCollectionId},{siteId}). However, if you want to sync data for a subsite ID, you must use the {hostname},{siteCollectionId},{siteId} format.
If you selected Advanced setup:
i. Enter the Tenant ID, Client ID, and Client Secret you found.
ii. In the Site ID field, enter the site ID that you found.
If you want to sync data for a site, you can enter either the site collection ({siteCollectionId}) or the full site ID ({hostname},{siteCollectionId},{siteId}). However, if you want to sync data for a subsite ID, you must use the {hostname},{siteCollectionId},{siteId} format.
iii. (Optional) Click Run connection test to validate the credentials and connection to SharePoint.
You can skip this intermediate test and proceed to the next step. However, if you choose to skip, we will perform this test once you have finished your configuration.
(Hybrid Deployment only) If your destination is configured for Hybrid Deployment, the Hybrid Deployment Agent associated with your destination is pre-selected for the connection. To assign a different agent, click Replace agent, select the agent you want to use, and click Use Agent.
Click Save & Test. Fivetran will take it from here and sync your Microsoft Lists data.

Activate history mode (optional)

You can enable or disable history mode for user-created lists. To configure history mode for individual lists, see our Activate History Mode documentation.

Connector Overview

Schema Information

Release Notes

API Connector Configuration

Documentation Home