SharePoint

SharePoint helps organizations share and collaborate with colleagues, partners, and customers. You can connect to SharePoint Online or to an on-premises SharePoint 2016 or 2019 farm using the On-Premises Data Gateway to manage documents and list items.

This connector is available in the following products and regions:

Service Class Regions
Copilot Studio Standard All Power Automate regions
Logic Apps Standard All Logic Apps regions
Power Apps Standard All Power Apps regions
Power Automate Standard All Power Automate regions
Contact
Name SharePoint
URL https://learn.microsoft.com/en-us/connectors/sharepoint/
Email idcknowledgeeco@microsoft.com
Connector Metadata
Publisher Microsoft
Website https://products.office.com/sharepoint/collaboration
Privacy policy https://privacy.microsoft.com/
Categories Content and Files

This reference article describes the operations and other information about the SharePoint connector available in the previously listed services and products.

General known issues and limitations

  • This connector supports list item attachment sizes up to 90 MB.
  • "Deprecated" triggers and actions are no longer actively maintained. While these operations still exist in this connector, you're strongly advised to not use them in any new solutions or apps.
  • Conditional access policies, such as multi-factor authentication or device compliance policies, might block access to data available through this connector. For more information, see Microsoft Entra ID Conditional Access.
  • Guest user accounts can't view or retrieve drop-down list information in connector operations.
  • If you get an incomplete data set, or if you can't get accurate results from a SharePoint list, this problem might by caused by delegation limits. For more information, see SharePoint delegation improvements.
  • This connector doesn't support setting up sensitivity labels on a SharePoint file.
  • Term set label updates don't automatically appear in a connected flow or app. To work around this problem, directly edit the affected list item to force refresh the term set label.
  • If the extraction process encounters special characters, the action named Extract folder might lead to character distortion. To avoid this problem, use a modern zip archive tool or library that adheres to the standard zip specification. This guidance means that the action should use the UTF-8 encoding process and set the language encoding header flag when the action constructs the zip file. For an example library, see the .NET Zip Archive SDK). This scenario isn't a limitation in the connector's ability to support special character zips in the operation, but rather an issue with the archive tool that leads to this problem.

Logic Apps

  • This connector supports file sizes up to 100 MB.
  • Uploads or downloads for larger files might fail due to buffer size limits. For larger files, consider other approaches such as Microsoft Graph API calls or intermediate storage.

Power Automate

  • Flows for lists are supported only in generic lists and generic document libraries. Custom list and library templates are currently unsupported, including but not limited to lists such as Announcements, Contacts, Events, and Tasks.
  • If you use the name for list or library as a dynamic value in the List Name parameter, and the name has a period anywhere, for example, MySharePoint.List, the name causes an error. To resolve this error, select the list from the dropdown menu in Power Automate. If you must use the name as a dynamic value, in the List Name parameter, enter the list's ID instead.
  • For flows that use the SharePoint trigger named For a selected file or For a selected item, the SharePoint Automate menu lists only the flows in the default environment.
  • The Power Automate portal doesn't list specific built-in SharePoint flows, such as Request sign-off, which are also uneditable.
  • For a flow with a SharePoint trigger, you can't undo the gesture to enable or disable the trigger's concurrency control. If you try, you get the "CannotDisableTriggerConcurrency" error. To work around this problem, export the flow and edit the JSON file to remove the "concurrency control" element. This action disables the concurrency option when you import the flow.

For more information about the connector in Power Automate, see:

Power Apps

  • Custom forms for lists are supported only in generic lists and generic document libraries. Custom list and library templates are currently unsupported, including but not limited to lists such as Announcements, Contacts, Events, and Tasks.
  • Custom forms for document libraries support only editing custom metadata. Editing or managing files is unsupported.
  • You can't move custom forms after creation to a different list or environment. However, you can set the environment where Power Apps saves new custom forms.
  • If the Customize forms option isn't available or doesn't correctly work for your list, the list might contain data types that Power Apps doesn't support.

SharePoint image column limitations in Power Apps

  • This connector supports image file sizes up to 90 MB for uploads to a list through Power Apps.
  • This connector supports only the listed image formats.
  • SharePoint image types might show Full, Large, Medium, and Small modifiers, for example, ThisItem.'Item Photo'.Small. Images with Small, Medium, and Large sizes are created on demand and temporarily cached. An image cached for too long is removed and regenerated on demand.
  • Power Apps generally refreshes image metadata every 30 seconds. If you create an app and want to immediately refresh the images, on the data source, select the ellipses button (...) to refresh the data.
  • Images stored in a collection won't correctly render. Try directly accessing them by using a Filter expression.
  • If you create an app from SharePoint or add a gallery control that connects to a SharePoint list with an image column, images might appear in the gallery even if the image column is hidden in the list. You can use the Power Apps fields list to show or hide any image field.

Data type mappings in Power Apps

For more information, see Data type mappings.

Functions and operations in Power Apps delegable to SharePoint

For more information, see Delegable functions and operations for SharePoint.

Delegation notes

  • You can delegate expressions joined by And or Or to SharePoint. You can't delegate expressions joined by Not.

  • SharePoint supports delegating complex types by deferring the delegation decision to the subfield involved. Check the subfield type on the complex type and then check the table in Delegable functions and operations for SharePoint for delegation capabilities. For the Person data type, you can delegate only Email and DisplayName.

  • The SharePoint ID field for a table is a number field in Power Apps. However, SharePoint supports only the equals operator (=) for delegation on an ID field.

  • You can't delegate a formula such as Filter(..., IsBlank(CustomerId)) to SharePoint. However, this formula is semantically close to Filter(..., CustomerId = Blank()), which you can delegate to SharePoint. These formulas aren't equivalent because the second formula doesn't treat the empty string ("") as empty. However, the second formula might work for your purposes. On SharePoint, this approach works for the equals operator (=) but not for the not equals operator (<>).

  • You can't delegate SharePoint system fields, including the following:

    • ContentType
    • FilenameWithExtension
    • FullPath
    • ​​​​​​Identifier
    • IsCheckedOut
    • IsFolder
    • Link​
    • Name
    • Path
    • ModerationComment
    • ModerationStatus
    • Thumbnail
    • TriggerWindowStartToken
    • TriggerWindowEndToken
    • VersionNumber

General Limits

Name Value
Maximum number of megabytes being transferred to/from the connector within a bandwidth time interval (per connection) 1000
Bandwidth time interval (in miliseconds) 60000

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
Gateway gatewaySetting On-prem gateway (see https://docs.microsoft.com/data-integration/gateway for more details
Authentication Type string Authentication type to connect to your database
Username securestring Username credential True
Password securestring Password credential True

Throttling Limits

Name Calls Renewal Period
API calls per connection 600 60 seconds

Actions

Add attachment

Adds a new attachment to the specified list item.

Agreements Solution - Generate document within Agreements Solution workspace

Use this action to create documents based on modern templates in a Agreements Solution workspace. This is behind a payment wall currently in planning (either license or PayG).

Approve hub site join request

Approve hub site join request. This will return an approval token that can be used to complete the join request using the join hub site action.

Cancel hub site join request

Cancel hub join request. If applicable, you should specify the same Approval Correlation Id as used in the "Set hub site join status to pending" action.

Check if the scheduled version of the item is published [DEPRECATED]

Returns the result in the output variable IsFilePublished.

Check in file

Check in a checked out file in a document library, which makes the version of the document available to others.

Check out file

Check out a file in a document library to prevent others from editing the document, and your changes from being visible until the documented is checked in.

Copy file

Copies a file. Works in a similar way to the "Copy to" command in SharePoint libraries. Returns information about the new file after copy.

Copy file (deprecated)

Copies a file to a SharePoint site.

Copy folder

Copies a folder. Works in a similar way to the "Copy to" command in SharePoint libraries. Returns information about the new folder after copy.

Create an approval request for an item or file

Creates an approval request for an item or file.

Create file

Uploads a file to a SharePoint site. Make sure to pick an existing library.

Create item

Creates a new item in a SharePoint list.

Create new document set

Creates a new document set list item.

Create new folder

Creates a new folder or folder path.

Create sharing link for a file or folder

Create sharing link for a file or folder.

Delete attachment

Deletes the specified attachment.

Delete file

Deletes the file specified by the file identifier.

Delete item

Deletes an item from a SharePoint list.

Discard check out

If you check out a file and don’t make changes to it, or you make changes that you don’t want to keep, you can simply discard the checkout, rather than saving the file. If your organization tracks versions, a new version is created each time you check a file back into the library. By discarding the checkout, you can avoid making new versions when you haven’t made any changes to the file.

Extract folder

Extracts an archive file into a SharePoint folder (example: .zip).

Generate a document from a form (preview)

Use this action to create documents from a document generation template. Map the template fields to the corresponding content in the data source. Document generation forms is a part of AI in SharePoint Public Preview. For more info on getting started, see: https://learn.microsoft.com/sharepoint/dev/declarative-customization/structured-documents.

Generate document using Microsoft Syntex (preview)

Use this action to create documents based on modern templates from Microsoft Syntex. This preview requires a Syntex license. Pricing is subject to change. For more info see: https://docs.microsoft.com/en-us/microsoft-365/contentunderstanding/content-assembly.

Get all lists and libraries

Get all lists and libraries.

Get attachment content

Returns file contents using the file identifier. The contents can be copied somewhere else, or be used as an attachment.

Get attachments

Returns the list of attachments for the specified list item. You can add a "Get attachment content" step and use the "File identifier" property returned by this action to get to the contents of the file.

Get changes for an item or a file (properties only)

Returns information about columns that have changed within a given time window. Note: The list must have Versioning turned on.

Get file content

Gets file contents using the file identifier. The contents can be copied somewhere else, or be used as an attachment.

Get file content using path

Gets file contents using the file path.

Get file metadata

Gets information about the file such as size, etag, created date, etc. Uses a file identifier to pick the file. Use "Get file properties" action to get to the values stored in the columns in the library.

Get file metadata using path

Gets information about the file such as size, etag, created date, etc. Uses a file path to pick the file. Use "Get file properties" action to get to the values stored in the columns in the library.

Get file properties

Gets the properties saved in the columns in the library for the item specified by the item id. You can add a "Get file content" step and use the "File identifier" property returned by this action to get to the contents of the file. When using this with the On-Premises Data Gateway, the name of the library to connect to may need to be entered manually.

Get file thumbnail

Gets the thumbnail of a file by its file identifier.

Get files (properties only)

Gets the properties saved in the columns in the library for all folders and files stored in the library. You can also filter down to the items that match a condition. An "Apply to each" section is usually used to work with the output from this action. When using this with the On-Premises Data Gateway, the name of the library to connect to may need to be entered manually.

Get folder metadata

Gets information about the folder. Uses a file identifier to pick the folder.

Get folder metadata using path

Gets information about the folder. Uses a folder path to pick the folder.

Get form metadata (preview)

Use this action to get the form metadata, which includes the form ID, title, link, form type, and the output format. It also gets the form questions used to collect information. Document generation forms is a part of AI in SharePoint Public Preview. For more info on getting started, see: https://learn.microsoft.com/sharepoint/dev/declarative-customization/structured-documents.

Get item

Gets a single item by its id from a SharePoint list.

Get items

Gets items from a SharePoint list.

Get list views

Gets views from a SharePoint list.

Get lists

Gets SharePoint lists from a site.

Grant access to an item or a folder

Grant access to an item or a folder in SharePoint to specific people.

Join hub site

Join the requested site to the hub site. An Approval Token is required to complete the join successfully if that hub requires approval. If applicable, you should specify the same Approval Correlation Id as used in the "Set hub site join status to pending" action.

List folder

Returns files contained in a SharePoint folder.

List root folder

Returns files in the root SharePoint folder.

Move file

Moves a file. Works in a similar way to the "Move to" command in SharePoint libraries. Returns information about the new file after move.

Move folder

Moves a folder. Works in a similar way to the "Move to" command in SharePoint libraries. Returns information about the new folder after move.

Resolve person

Returns a single matching user value so it can be assigned to a column of type person. If there are no matches, or multiple matches, this action will error out.

Send an HTTP request to SharePoint

Construct a SharePoint REST API to invoke. Note – This action may execute any SharePoint REST API you have access to. Please proceed with caution.

Set content approval status

Sets the content approval status for an item in a list or library that has content approval turned on. You must provide an ETag for pages and files. You can get the ETag using the Get File Metadata action. This action is only available for SharePoint Online and SharePoint 2019.

Set hub site join status to pending

Set the requested site's hub join request status to pending. The Approval Correlation Id is an optional parameter that helps SharePoint identify a particular hub join request. The requesting site can only have one pending request at a given time.

Stop sharing an item or a file

Delete all links giving access to an item or a file and remove all people with direct access except for owners.

Update file

Updates the contents of the file specified by the file identifier.

Update file properties

Updates the properties stored in columns in a library for the item specified by the item id. Use "Update file" action to update file contents. When using this with the On-Premises Data Gateway, the name of the library to connect to may need to be entered manually.

Update file properties using AI Builder model results

Updates the values stored in library columns for a file analyzed by the model specified by the ModelId.

Update item

Updates an item in a SharePoint list.

Add attachment

Adds a new attachment to the specified list item.

Parameters

Name Key Required Type Description
Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename.

List Name
table True string

SharePoint list name.

Id
itemId True integer

Id of the list item to attach the file to.

File Name
displayName True string

File name.

File Content
body True binary

Content of the file.

Returns

SharePoint list item attachment

Agreements Solution - Generate document within Agreements Solution workspace

Use this action to create documents based on modern templates in a Agreements Solution workspace. This is behind a payment wall currently in planning (either license or PayG).

Parameters

Name Key Required Type Description
Agreements Solution Workspace
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename.

Agreements Solution Template
template True string

Agreements Solution template.

Fields
item True dynamic

Document placeholder values.

File Name
documentName string

Document file name.

Returns

The SharePoint version of the BlobMetadataResponse extends the object by adding some additional fields that we want serialized

Approve hub site join request

Approve hub site join request. This will return an approval token that can be used to complete the join request using the join hub site action.

Parameters

Name Key Required Type Description
Hub Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename.

Requesting Site Id
joiningSiteId True string

Id of the requesting site.

Returns

Result object of ApproveHubSiteJoin action

Cancel hub site join request

Cancel hub join request. If applicable, you should specify the same Approval Correlation Id as used in the "Set hub site join status to pending" action.

Parameters

Name Key Required Type Description
Requesting Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename.

Approval Correlation Id
approvalCorrelationId string

Approval correlation identifier for this request.

Check if the scheduled version of the item is published [DEPRECATED]

Returns the result in the output variable IsFilePublished.

Parameters

Name Key Required Type Description
Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename.

Library Name
table True string

SharePoint library name.

Item ID
id True integer

Unique identifier of the file.

Scheduled Version
scheduledVersion True string

Version of file that was scheduled for publish.

Returns

Output object of the CheckIfFileIsPublished endpoint on the SPO Connector shim

Check in file

Check in a checked out file in a document library, which makes the version of the document available to others.

Parameters

Name Key Required Type Description
Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename.

Library Name
table True string

SharePoint library name.

Id
id True integer

Id of the list item the file is attached to.

Comments
comment True string

Type comments describing what has changed in this version

Check in type
checkinType True integer

Select the type of version you would like to check in

Check out file

Check out a file in a document library to prevent others from editing the document, and your changes from being visible until the documented is checked in.