SharePoint Online integration

SharePoint document libraries: list folders, download & upload files (attended or unattended)

Help CentreConnectors

Overview

SharePoint Online – SharePoint document libraries: list folders, download & upload files (attended or unattended)


Available operations

14 operations available. Click any row to jump to its detail.

OperationCategoryWhat it does
Create FolderGeneralCreate a folder in a library by parent path
Delete ItemGeneralDelete a file or folder by its drive-item ID
Download FileGeneralDownload a single file to the client machine (by item_id or by path)
Download FolderGeneralDownload every file in a folder to a local directory
Get ItemGeneralGet a file/folder by its drive-item ID
Get Root SiteGeneralGet the tenant's root SharePoint site
Get SiteGeneralGet a SharePoint site by its Graph site ID
Get Site by PathGeneralResolve a site by hostname + path (host=acme.sharepoint.com, site_path=sites/Finance)
List Folder Children (by item ID)GeneralList items inside a folder identified by its drive-item ID
List Document LibrariesGeneralList the document libraries (drives) on a site
List FolderGeneralList items in a folder by its library-relative path (empty path = library root)
Resolve Site URLGeneralResolve a full SharePoint site URL to its Graph site object
Search SitesGeneralSearch SharePoint sites by keyword (pass 'search')
Upload FileGeneralUpload a local file into a folder (handles large files via upload session)

Operations

Create Folder

Create a folder in a library by parent path

ParameterRequiredTypeDescription
Site URL site_urlNotextSharePoint site URL, resolved to a site automatically – provide this OR Site ID. e.g. https://acme.sharepoint.com/sites/Finance
Site ID site_idNotextGraph site id (e.g. from a resolve-site-url step). Optional when Site URL is given.
Folder Name nameYestextName of the new folder.
Parent Folder parent_pathNotextParent folder path. Blank = library root.
On Conflict conflict_behaviorNotextrename | replace | fail (default rename).
Document Library ID drive_idNotextSpecific document library, if the site has more than one. Optional – defaults to the site's default.

Delete Item

Delete a file or folder by its drive-item ID

ParameterRequiredTypeDescription
Site Id site_idYestext
Item Id item_idYestext

Download File

Download a single file to the client machine (by item_id or by path)

ParameterRequiredTypeDescription
Site URL site_urlNotextSharePoint site URL, resolved to a site automatically – provide this OR Site ID. e.g. https://acme.sharepoint.com/sites/Finance
Site ID site_idNotextGraph site id (e.g. from a resolve-site-url step). Optional when Site URL is given.
File Path pathNotextLibrary-relative file path, e.g. Documents/Report.xlsx (or use Item ID).
Item ID item_idNotextDrive-item id of the file (alternative to File Path).
Save Path save_pathYestextLocal destination path on the client machine.
Document Library ID drive_idNotextSpecific document library, if the site has more than one. Optional – defaults to the site's default.
Share Link URL share_urlNotextA SharePoint/OneDrive sharing link (the URL from Share → Copy link). When given, the item is resolved straight from the link and Site URL/ID + Folder/File Path are ignored – use this for a shared file/folder (incl. personal OneDrive) where no site is known.

Download Folder

Download every file in a folder to a local directory

ParameterRequiredTypeDescription
Site URL site_urlNotextSharePoint site URL, resolved to a site automatically – provide this OR Site ID. e.g. https://acme.sharepoint.com/sites/Finance
Site ID site_idNotextGraph site id (e.g. from a resolve-site-url step). Optional when Site URL is given.
Folder Path folder_pathNotextLibrary-relative folder path. Blank = library root.
Save Directory save_dirYestextLocal directory to download the files into.
Include Subfolders recursiveNobooleanDescend into subfolders. Off by default.
Document Library ID drive_idNotextSpecific document library, if the site has more than one. Optional – defaults to the site's default.
Share Link URL share_urlNotextA SharePoint/OneDrive sharing link (the URL from Share → Copy link). When given, the item is resolved straight from the link and Site URL/ID + Folder/File Path are ignored – use this for a shared file/folder (incl. personal OneDrive) where no site is known.

Get Item

Get a file/folder by its drive-item ID

ParameterRequiredTypeDescription
Site Id site_idYestext
Item Id item_idYestext

Get Root Site

Get the tenant's root SharePoint site

No input parameters.


Get Site

Get a SharePoint site by its Graph site ID

ParameterRequiredTypeDescription
Site Id site_idYestext

Get Site by Path

Resolve a site by hostname + path (host=acme.sharepoint.com, site_path=sites/Finance)

ParameterRequiredTypeDescription
Hostname hostnameYestext
Site Path site_pathYestext

List Folder Children (by item ID)

List items inside a folder identified by its drive-item ID

ParameterRequiredTypeDescription
Site Id site_idYestext
Item Id item_idYestext

List Document Libraries

List the document libraries (drives) on a site

ParameterRequiredTypeDescription
Site Id site_idYestext

List Folder

List items in a folder by its library-relative path (empty path = library root)

ParameterRequiredTypeDescription
Site URL site_urlNotextSharePoint site URL, resolved to a site automatically – provide this OR Site ID. e.g. https://acme.sharepoint.com/sites/Finance
Site ID site_idNotextGraph site id (e.g. from a resolve-site-url step). Optional when Site URL is given.
Folder Path folder_pathNotextLibrary-relative folder path, e.g. Documents/Invoices. Blank lists the library root.
Document Library ID drive_idNotextSpecific document library, if the site has more than one. Optional – defaults to the site's default.
Share Link URL share_urlNotextA SharePoint/OneDrive sharing link (the URL from Share → Copy link). When given, the item is resolved straight from the link and Site URL/ID + Folder/File Path are ignored – use this for a shared file/folder (incl. personal OneDrive) where no site is known.

Resolve Site URL

Resolve a full SharePoint site URL to its Graph site object

ParameterRequiredTypeDescription
Site URL urlYestextFull SharePoint site URL, e.g. https://acme.sharepoint.com/sites/Finance

Search Sites

Search SharePoint sites by keyword (pass 'search')

No input parameters.


Upload File

Upload a local file into a folder (handles large files via upload session)

ParameterRequiredTypeDescription
Site URL site_urlNotextSharePoint site URL, resolved to a site automatically – provide this OR Site ID. e.g. https://acme.sharepoint.com/sites/Finance
Site ID site_idNotextGraph site id (e.g. from a resolve-site-url step). Optional when Site URL is given.
Local File local_pathYestextPath to the local file to upload.
Destination Folder folder_pathNotextDestination folder in the library. Blank = library root.
Destination Name dest_nameNotextOverride the uploaded file name (defaults to the local file name).
On Conflict conflict_behaviorNotextrename | replace | fail (default replace).
Document Library ID drive_idNotextSpecific document library, if the site has more than one. Optional – defaults to the site's default.

See it working on your own data

Everything documented here ships with the platform – try the document tools free, or go live in 7 days.