Toggle menu

search

Description

Performs a search query against SharePoint. The search will be performed against the baseUrl set in the AuthDetails you use in your request (see worker configuration). For MSAL this should be a specific site.

The query parameter contains the query you want to use to search SharePoint. You can supply the query as * to search for everything.

Parameters

NameTypeDescription
queryString, requiredThe search query to send to SharePoint
authDetailsObject, optionalThe authDetails set in the worker configuration to use. If not set the request will use the default authDetails
authDetails.identifierStringThe identifier of authDetails set in the worker configuration
authDetails.authTypeStringThe authType of authDetails set in the worker configuration
returnPropertiesArray[strings], optionalAn array of strings containing the metadata properties you want to retrieve. If not set all properties are returned
documentsOnlyBoolean, optionalIf true only documents will be searched
rowLimitInteger, optionalThe maximum number of rows to be returned from the search query
startRowInteger, optionalThe number of the first row to be returned from the search query

Example

{
    "id": "123",
    "jsonrpc": "2.0",
    "method": "search",
    "params": {
        "authDetails": {
            "identifier": "GossTest",
            "authType": "MSAL"
        },
        "query": "TestDocument",
        "documentsOnly": true,
        "startRow": 15,
        "rowLimit": 5,
        "returnProperties": ["Path", "Title"]
    }
}

Last modified on 2 December 2025