Knowledge_Base_Microsoft_Sharepoint
Search across a SharePoint tenant for sites that match keywords provided.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]Successful Response
Validation Error
Get a site by its ID.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]Successful Response
Validation Error
retrieve a site based on server-relative URL path. Site collection hostname and Site path, relative to server hostname.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]Successful Response
Validation Error
List all subsites for a site.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]Successful Response
Validation Error
Search the hierarchy of items for items matching a query. searches for a match across several fields in the signed-in user's drive items.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]Successful Response
Validation Error
Get SharePoint site ID by searching for a site with a specific name. Returns site information including the site ID that can be used in other endpoints.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]Query parameters for filtering and selecting results
Successful Response
Validation Error
List all permission assignments for a specific file or folder in SharePoint, including users and groups with their roles.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]Successful Response
Validation Error
List all items (files and folders) in a SharePoint site's default drive to get their IDs for permission management. Supports pagination and filtering.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]Optional query parameters for filtering, pagination, and sorting.
Successful Response
Validation Error
List all items (files and folders) in a specific folder within a SharePoint site's drive. Use this to navigate into folders and list their contents.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]Optional query parameters for filtering, pagination, and sorting.
Successful Response
Validation Error
Get metadata of a file or folder in a SharePoint site's document library.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]Successful Response
Validation Error
List all files and folders in a SharePoint site recursively using delta API. Provides reliable cursor-based pagination with proper $top support and efficient traversal of large datasets.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]Query parameters for filtering, selection, and cursor-based pagination.
Successful Response
Validation Error
Create a subscription to receive webhook notifications for changes in a SharePoint drive. The subscription monitors the drive root and sends notifications to the specified webhook URL when changes occur. Maximum subscription duration is 4230 minutes (approximately 3 days).
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]Successful Response
Validation Error
Delete an existing subscription to stop receiving webhook notifications. Once deleted, the subscription cannot be recovered and must be recreated if needed.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]Successful Response
Validation Error
Get details of a specific subscription including its resource, notification URL, expiration time, and client state.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]Successful Response
Validation Error
Renew an existing subscription by extending its expiration time. This prevents the subscription from expiring and stops receiving notifications.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]The request body for renewing a subscription.
Successful Response
Validation Error
List all document libraries (drives) in a SharePoint site with detailed information including drive ID, name, type, web URL, and associated list information.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]Query parameters for selecting and expanding properties.
Successful Response
Validation Error
Track changes in a SharePoint drive using delta API. Returns items that have been added, modified, or deleted since the last delta query. Provide delta_token from previous @odata.deltaLink to get changes since that point, or leave empty for initial sync. Set exclude_parent=true to exclude parent items from the response.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]Query parameters for delta tracking.
Successful Response
Validation Error
Get the profile information of the currently logged-in user, including email address, display name, job title, and other user properties. Useful for identifying which account is being used for SharePoint operations.
Successful Response
Successful Response
Get a specific driveItem (file or folder) by its ID. Use this to retrieve detailed information about an item whose ID was obtained from the delta API or other listing operations. Supports $select to choose specific properties and $expand to include related data.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]Optional query parameters to customize the response.
Successful Response
Validation Error
Last updated