You can use this Snap to read metadata of a list from the SharePoint Online site. Also, as an option, it enables you to read a specific entry of the list or get all entries in the list along with its metadata.
ValidSharePoint Online tenant and associated site.
Valid Azure application with all the required API permissions.
An input document contains the metadata of the list to be retrieved.
An output document contains the metadata information of a list.
Specify the name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your Pipeline.
SharePoint Online - List Read
Specify the name of a site that contains the list of document library to be used in the subsequent settings.
Custom Site Path
Enable this option if your site URL contains a custom path that deviates from the default site URL. Default site path always has a prefix ‘sites/’ before the sitename, a custom site can contain the prefix ‘teams/’ or it can have no prefix.
Optional. This property enables you to select the name of the list. This field suggest all the list that belong to the SharePoint Online site.
If you enable the Site property as an expression, then the document library is not suggested, resulting in an exception.
Optional. The unique item id of the Item to be read.
Optional.Enter the comma-separated properties to be written to the output view.
Enable this checkbox to get the items of the specified list along with the list metadata.
Optional. Enable this checkbox to get the column metadata along with the list metadata.
You can use this field setto influence connection properties to the SharePoint Online APIs.
This field set comprises the following fields:
Retry interval (seconds)
This property enables you to set the connection timeout duration in seconds.
Number of retries*
This property enables you to set the maximum number of re-connections in case of connection failure or timeout.
Retry interval (seconds)*
This property enables you to set the time interval in seconds between connection attempts.
Specifies the execution type:
Validate & Execute. Performs limited execution of the Snap (up to 50 records) during Pipeline validation; performs full execution of the Snap (unlimited records) during Pipeline execution.
Execute only. Performs full execution of the Snap during Pipeline execution; does not execute the Snap during Pipeline validation.
Disabled. Disables the Snap and, by extension, its downstream Snaps.
Validate & Execute
For more information on how to read a list in the SharePoint Online, refer to the graph API in list-get.
HTTP Response Code:404
Entered item not found in the document library
Please ensure to provide the valid item path to get the metadata.
Either user or app doesn't have sufficient permissions to read the metadata for the document library.
Ensure to provide the desired permissions both at the user and application level.
Reading Items on a List
This example demonstrates how to retrieve the metadata of a list along with its columns and items. The example assumes that you have configured & authorized a valid SharePoint Online Account (see SharePoint Online Account).
First, we configure the SharePoint Online - List Read Snap as follows to get the list along with its items and columns metadata.
After successfully validating/executing of the Snap, the results display in the output preview.