SharePoint API Configuration
Request
POST https://api.fivetran.com/v1/connections
{ "group_id": "group_id", "service": "share_point", "trust_certificates": true, "trust_fingerprints": true, "run_setup_tests": true, "paused": false, "pause_after_trial": false, "sync_frequency": 1440, "data_delay_sensitivity": "NORMAL", "data_delay_threshold": 0, "daily_sync_time": "14:00", "schedule_type": "auto", "connect_card_config": { "redirect_uri": "https://your.site/path", "hide_setup_guide": true }, "proxy_agent_id": "proxy_agent_id", "private_link_id": "private_link_id", "networking_method": "Directly", "hybrid_deployment_agent_id": "hybrid_deployment_agent_id", "destination_configuration": { "virtual_warehouse": "virtual_warehouse" }, "destination_schema_names": "SOURCE_NAMING", "config": { "access_type": "CUSTOM_APP | SPECIFIC_SITES | CLIENT_CERTIFICATE | ALL_SITES", "append_file_option": "upsert_file_with_primary_keys | upsert_file | append_file", "archive_pattern": "regex_pattern", "client_certificate": "client_certificate", "client_certificate_private_key": "certificate_private_key", "compression": "zip | gz | tar_gz | tar | infer | gzip | uncompressed | bz2 | tar_bz2", "delimiter": "|", "empty_header": true, "escape_char": "escape_char", "file_handling": "structured", "file_type": "tsv | xml | csv | spreadsheet | json | jsonl | avro | parquet", "files": [ { "archive_pattern": "string", "file_pattern": "string", "selected_range": "'Sheet1'!A1", "table_name": "string" } ], "is_single_table_mode": true, "json_delivery_mode": "Packed | Unpacked", "line_separator": ";", "null_sequence": "string", "on_error": "fail | skip", "pattern": "file_pattern", "prefix": "folder_link_url", "quote_char": "string", "quote_character_enabled": true, "selected_range": "'Sheet1'!A1", "share_url": "target_share_url", "skip_after": 0, "skip_before": 0, "sync_nested_files": true, "sync_permissions": true, "schema": "schema_name", "table_group_name": "string" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token", "tenant_id": "my_tenand_id" } }
Config parameters
| Name | Description |
|---|---|
access_type | Access Type |
append_file_option | If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number. |
archive_pattern | Files inside of compressed archives with filenames matching this regular expression will be synced. We have discontinued this field, and will stop supporting it by August 31, 2026. |
client_certificate | Client Certificate of your Microsoft client application. |
client_certificate_private_key | Certificate Private Key of your Microsoft client application. |
compression | The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format. |
delimiter | You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible. |
empty_header | Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. |
escape_char | If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. |
file_handling | Files will be processed and synced according to the selected file handling option. Supported values:structured- (Default) Extract structured data into destination tables for analysis. Commonly used.unstructured- Replicate files in their original format. Best for PDFs, images, and other unstructured content. Learn more about unstructured file replication in our documentation.. |
file_type | If your files are saved with improper extensions, you can force them to be synced as the selected file type. |
files | Mapped file name patterns to a destination table. |
files[0].archive_pattern | All Files inside of compressed archives with filenames matching this regular expression will be synced. |
files[0].file_pattern | All files in your search path matching this regular expression will be synced per table. |
files[0].selected_range | Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the '<sheetName>'!<startColumnName><startRowNumber> format. |
files[0].table_name | All files matching the above pattern will be synced to this table. |
is_single_table_mode | Allows the creation of connector using Merge Mode strategy. |
json_delivery_mode | Control how your JSON data is delivered into your destination |
line_separator | You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next. |
null_sequence | If your CSVs use a special value indicating null, you can specify it here. |
on_error | If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as fail unless you are certain that you have undesirable, malformed data. |
pattern | All files in your search path matching this regular expression will be synced. We have discontinued this field, and will stop supporting it by August 31, 2026. |
prefix | The connection will look for files in the folder of the URL you provide. Choose the lowest common folder in a folder hierarchy that includes all the files you want to sync. This defines a specific location where Fivetran scans for files and helps ensure optimal performance. |
quote_char | You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true. |
quote_character_enabled | If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character. |
selected_range | Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the '<sheetName>'!<startColumnName><startRowName> format. |
share_url | Your SharePoint folder URL. You can find the folder URL by following the steps mentioned here. |
skip_after | We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. |
skip_before | We will skip over the number of lines specified before syncing data. |
sync_nested_files | Optional. Set to true to sync files from nested folders within the specified folder. |
sync_permissions | Optional. Set to true to sync per-user file access permissions to control visibility in downstream applications. |
schema (required) | Destination schema name. Schema name is permanent and cannot be changed after connection creation |
table_group_name (required) | Combined with the schema to form the Fivetran connection name <schema>.<table_group_name>. Lets you create multiple Merge Mode connections per schema. |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the
client_accessandrefresh_tokenparameters in theauthsection.POST https://api.fivetran.com/v1/connections{ "service": "share_point", "group_id": "group_id", "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }Auth Parameters
Name Description client_accessclient_access.client_idClient IDof your Microsoft client application.client_access.client_secretClient Secretof your Microsoft client application.refresh_tokenThe long-lived Refresh token carries the information necessary to get a new access token for API resources. It is recommended to use this authorization with theCUSTOM_APPaccess type. By using the Connect Card or the Fivetran dashboard.