SharePoint Online - Search Items

In this article


You can use this Snap to perform a search for the hierarchy of items matching the search query. You can search within a folder hierarchy, a whole drive, or files shared with the current user.

Snap Type

SharePoint Online - Search Items Snap is a Read-type Snap.


  • Valid SharePoint Online tenant and associated site.

  • Valid Azure application with all the required API permissions.

Support for Ultra Pipelines

Works in Ultra Pipelines. Works in Ultra Pipelines. However, we recommend that you not use this Snap in an Ultra Pipeline. To know the list of Snaps that work in Ultra and the related caveats, see Snap Support for Ultra Pipelines.

Limitations and Known Issues


Snap Views



Number of Views

Examples of Upstream and Downstream Snaps




Number of Views

Examples of Upstream and Downstream Snaps




  • Min: 0

  • Max: 1

  • Mapper

  • Copy

  • CSV Parser

  • JSON Parser

An input document contains the metadata of the item that can be used in the search item query.



  • Min: 1

  • Max: 1

  • Mapper Snap

  • Copy Snap

  • CSV Parser

  • JSON Parser

An output document contains the metadata information of items that match the search query.


Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter when running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab:

  • Stop Pipeline Execution: Stops the current pipeline execution if the Snap encounters an error.

  • Discard Error Data and Continue: Ignores the error, discards that record, and continues with the remaining records.

  • Route Error Data to Error View: Routes the error data to an error view without stopping the Snap execution.

Learn more about Error handling in Pipelines.

Snap Settings

  • Asterisk (*): Indicates a mandatory field.

  • Suggestion icon (): Indicates a list that is dynamically populated based on the configuration.

  • Expression icon (): Indicates whether the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.

  • Add icon (): Indicates that you can add fields in the field set.

  • Remove icon (): Indicates that you can remove fields from the field set.

Field Name

Field Type


Field Name

Field Type




Default Value: SharePoint Online - Search Items
Example: SharePoint Online - Search Items


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.



Default Value: N/A


Specify the name of a site which contains the list of document library to be used in the subsequent Snap settings.


Custom Site Path


Default ValueDeselected


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.

Document Library*


Default Value: N/A
ExampleShared Documents


Specify the a drive representing the top-level container for a file system, such as OneDrive or SharePoint document libraries. This field will be populated dynamically from different sites from the suggestion drop-down list. You can either choose a document library from suggestion drop-down list or enter the entity name manually.

If you enable the Site property as an expression, then the document library is not suggested, resulting in an exception.

Source Item Relative Path*


Default Value: N/A


Specify the item resource path that represents a file, folder, or other item stored in a document library.

Search Query


Default Value: N/A
Example: pdf


Specify keywords to be searched. It searches the filenames and content of files in SharePoint Online and finds matching documents.

Select Fields


Default Value: N/A
Exampleid, email, roles


Enter the comma-separated properties to be written to the output view.

Order by Properties

Use this fieldset to Enter the properties and order they want to be displayed when found more one item with one or more similar properties. 

Property name


Default Value: N/A


Specify the attribute name of the item/drive/folder to be sorted.

Order type


Default Valueasc

Dropdown list/Expression

Select the appropriate order type to perform the sorting at the server-side. Avaialble options are:

  • asc

  • desc



Default Value200


Specify an integer value to define the number of retrieved list items to be displayed per page (pagination).

While providing a value in this field, do not select Auto pagination check box.

Auto pagination


Default Value: Deselected


Select this checkbox to retrieve all items within the selected folder/directory. If not selected (by default), the Snap returns a maximum of 200 records per page.

Connection details

Use this field set to specify connection properties to the SharePoint Online APIs. 

Connection Timeout*


Default Value30


Specify the connection timeout duration in seconds.

Number of Retries*


Default Value3


Specify the maximum number of reconnections in case of a connection failure or timeout.

Retry Interval (seconds)*


Default Value10


Specify the time interval in seconds between connection attempts.

Snap Execution


Default ValueValidate & Execute
ExampleExecute only

Dropdown list

Specify the required Pipeline 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.








HTTP Response Code:404

Entered item not found in the document library.

Ensure to provide the valid item path to get the metadata.

Forbidden exception:403

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.

Internal Server Error: 501

Value for the Property name might have missed.

Ensure to provide the value for the property name in the Order by Properties.


Searching for PDF files

This example demonstrates how to search for PDF files in the document library. The example assumes that you have configured and authorized a valid SharePoint Online Account. For more information, refer to SharePoint Online Account.

The following screenshot displays the settings of the SharePoint Online - Search Items. This Snap searches all PDFs available in the selected document library and order the output documents based on the item name.

After successfully validating/executing the above Snap, the results display in the following output preview.

Download this Pipeline.


  File Modified

File Example_sharepoint_Search_Items.slp

Mar 11, 2022 by Subhajit Sengupta

Snap Pack History