Use SharePoint in Sim to list sites, manage pages and lists, update list items, and upload or download files. Connect a Microsoft account through OAuth, then choose the target site or resource for each operation.
Sim requests these scopes when someone connects a SharePoint account. For a self-hosted deployment, register your own app with the provider using the settings below. See Integrations and OAuth for setup.
Setting Value Redirect URI <NEXT_PUBLIC_APP_URL>/api/auth/oauth2/callback/sharepointEnvironment variables MICROSOFT_CLIENT_ID, MICROSOFT_CLIENT_SECRET
Scope Description openidStandard authentication profileAccess profile information emailAccess email address Sites.Read.AllRead documents and list items in all SharePoint sites Sites.ReadWrite.AllCreate, edit, and delete documents and list items in all SharePoint sites Sites.Manage.AllCreate and delete lists and document libraries in all SharePoint sites offline_accessAccess account when not using the application
Read/create pages, list sites, and work with lists (read, create, update items). Requires OAuth.
Create a new page in a SharePoint site
Parameter Type Required Description siteIdstring No The ID of the SharePoint site (internal use) siteSelectorstring No Select the SharePoint site pageNamestring Yes The name of the page to create. Example: My-New-Page.aspx or Report-2024.aspx pageTitlestring No The title of the page (defaults to page name if not provided) pageContentstring No The content of the page
Parameter Type Description pageobject Created SharePoint page information ↳ id string The unique ID of the created page ↳ name string The name of the created page ↳ title string The title of the created page ↳ webUrl string The URL to access the page ↳ pageLayout string The layout type of the page ↳ createdDateTime string When the page was created ↳ lastModifiedDateTime string When the page was last modified
Read a specific page from a SharePoint site
Parameter Type Required Description siteSelectorstring No Select the SharePoint site siteIdstring No The ID of the SharePoint site (internal use) pageIdstring No The ID of the page to read. Example: a GUID like 12345678-1234-1234-1234-123456789012 pageNamestring No The name of the page to read (alternative to pageId). Example: Home.aspx or About-Us.aspx maxPagesnumber No Maximum number of pages to return when listing all pages (default: 10, max: 50) nextPageUrlstring No Full @odata.nextLink URL from a previous Microsoft Graph page response
Parameter Type Description pageobject Information about the SharePoint page ↳ id string The unique ID of the page ↳ name string The name of the page ↳ title string The title of the page ↳ webUrl string The URL to access the page ↳ pageLayout string The layout type of the page ↳ description string The description of the page ↳ createdDateTime string When the page was created ↳ lastModifiedDateTime string When the page was last modified pagesarray List of SharePoint pages ↳ page object ↳ id string The unique ID of the page ↳ name string The name of the page ↳ title string The title of the page ↳ webUrl string The URL to access the page ↳ pageLayout string The layout type of the page ↳ description string The description of the page ↳ createdDateTime string When the page was created ↳ lastModifiedDateTime string When the page was last modified ↳ content object ↳ content string Extracted text content from the page ↳ canvasLayout object Raw SharePoint canvas layout structure contentobject Content of the SharePoint page ↳ content string Extracted text content from the page ↳ canvasLayout object Raw SharePoint canvas layout structure totalPagesnumber Total number of pages found nextPageUrlstring Full Microsoft Graph @odata.nextLink URL for the next page of results
Update the title and/or content of a SharePoint page
Parameter Type Required Description siteIdstring No The ID of the SharePoint site (internal use) siteSelectorstring No Select the SharePoint site pageIdstring Yes The ID of the page to update. Example: a GUID like 12345678-1234-1234-1234-123456789012 pageTitlestring No The new title of the page pageContentstring No The new text content of the page. Replaces the entire canvas layout of the page.
Parameter Type Description pageobject Updated SharePoint page information ↳ id string The unique ID of the page ↳ name string The name of the page ↳ title string The title of the page ↳ webUrl string The URL to access the page ↳ pageLayout string The layout type of the page ↳ createdDateTime string When the page was created ↳ lastModifiedDateTime string When the page was last modified
Publish the latest version of a SharePoint page, making it available to all users
Parameter Type Required Description siteSelectorstring No Select the SharePoint site siteIdstring No The ID of the SharePoint site (internal use) pageIdstring Yes The ID of the page to publish. Example: a GUID like 12345678-1234-1234-1234-123456789012
Parameter Type Description publishedboolean Whether the page was published pageIdstring The ID of the published page
Delete a page from a SharePoint site
Parameter Type Required Description siteSelectorstring No Select the SharePoint site siteIdstring No The ID of the SharePoint site (internal use) pageIdstring Yes The ID of the page to delete. Example: a GUID like 12345678-1234-1234-1234-123456789012
Parameter Type Description deletedboolean Whether the page was deleted pageIdstring The ID of the deleted page
List details of all SharePoint sites
Parameter Type Required Description siteSelectorstring No Select the SharePoint site siteIdstring No The ID of the SharePoint site (internal use) groupIdstring No The group ID for accessing a group team site. Example: a GUID like 12345678-1234-1234-1234-123456789012 nextPageUrlstring No Full @odata.nextLink URL from a previous Microsoft Graph page response
Parameter Type Description siteobject Information about the current SharePoint site ↳ id string The unique ID of the site ↳ name string The name of the site ↳ displayName string The display name of the site ↳ webUrl string The URL to access the site ↳ description string The description of the site ↳ createdDateTime string When the site was created ↳ lastModifiedDateTime string When the site was last modified ↳ isPersonalSite boolean Whether this is a personal site ↳ root object Present (as an empty object) only when this site is the root of its site collection ↳ siteCollection object ↳ hostname string Site collection hostname sitesarray List of all accessible SharePoint sites ↳ id string The unique ID of the site ↳ name string The name of the site ↳ displayName string The display name of the site ↳ webUrl string The URL to access the site ↳ description string The description of the site ↳ createdDateTime string When the site was created ↳ lastModifiedDateTime string When the site was last modified nextPageUrlstring Full Microsoft Graph @odata.nextLink URL for the next page of results
Create a new list in a SharePoint site
Parameter Type Required Description siteIdstring No The ID of the SharePoint site (internal use) siteSelectorstring No Select the SharePoint site listDisplayNamestring Yes Display name of the list to create. Example: Project Tasks or Customer Contacts listDescriptionstring No Description of the list listTemplatestring No List template name (e.g., 'genericList') pageContentjson No Optional JSON of columns. Either a top-level array of column definitions or an object with { columns: [...] }.
Parameter Type Description listobject Created SharePoint list information ↳ id string The unique ID of the list ↳ displayName string The display name of the list ↳ name string The internal name of the list ↳ webUrl string The web URL of the list ↳ createdDateTime string When the list was created ↳ lastModifiedDateTime string When the list was last modified ↳ list object List properties (e.g., template)
Get metadata (and optionally columns/items) for a SharePoint list
Parameter Type Required Description siteSelectorstring No Select the SharePoint site siteIdstring No The ID of the SharePoint site (internal use) listIdstring No The ID of the list to retrieve. Example: b!abc123def456 or a GUID like 12345678-1234-1234-1234-123456789012 includeColumnsboolean No Whether to include column definitions when retrieving a specific list includeItemsboolean No Whether to include list items when retrieving a specific list nextPageUrlstring No Full @odata.nextLink URL from a previous Microsoft Graph page response
Parameter Type Description listobject Information about the SharePoint list ↳ id string The unique ID of the list ↳ displayName string The display name of the list ↳ name string The internal name of the list ↳ webUrl string The web URL of the list ↳ createdDateTime string When the list was created ↳ lastModifiedDateTime string When the list was last modified ↳ list object List properties (e.g., template) ↳ columns array List column definitions ↳ items array List items (with fields when expanded) ↳ id string Item ID ↳ fields object Field values for the item listsarray All lists in the site when no listId/title provided itemsarray List items with expanded fields when reading list items ↳ id string Item ID ↳ fields object Field values for the item nextPageUrlstring Full Microsoft Graph @odata.nextLink URL for the next page of results
Update the properties (fields) on a SharePoint list item
Parameter Type Required Description siteSelectorstring No Select the SharePoint site siteIdstring No The ID of the SharePoint site (internal use) listIdstring Yes The ID of the list containing the item. Example: b!abc123def456 or a GUID like 12345678-1234-1234-1234-123456789012 itemIdstring Yes The ID of the list item to update. Example: 1, 42, or 123 listItemFieldsjson Yes Field values to update on the list item
Parameter Type Description itemobject Updated SharePoint list item ↳ id string Item ID ↳ fields object Updated field values
Add a new item to a SharePoint list
Parameter Type Required Description siteSelectorstring No Select the SharePoint site siteIdstring No The ID of the SharePoint site (internal use) listIdstring Yes The ID of the list to add the item to. Example: b!abc123def456 or a GUID like 12345678-1234-1234-1234-123456789012 listItemFieldsjson Yes Field values for the new list item
Parameter Type Description itemobject Created SharePoint list item ↳ id string Item ID ↳ fields object Field values for the new item
Get a single item (with field values) from a SharePoint list
Parameter Type Required Description siteSelectorstring No Select the SharePoint site siteIdstring No The ID of the SharePoint site (internal use) listIdstring Yes The ID of the list containing the item. Example: b!abc123def456 or a GUID like 12345678-1234-1234-1234-123456789012 itemIdstring Yes The ID of the list item to retrieve. Example: 1, 42, or 123
Parameter Type Description itemobject SharePoint list item with field values ↳ id string Item ID ↳ fields object Field values for the item
Delete an item from a SharePoint list
Parameter Type Required Description siteSelectorstring No Select the SharePoint site siteIdstring No The ID of the SharePoint site (internal use) listIdstring Yes The ID of the list containing the item. Example: b!abc123def456 or a GUID like 12345678-1234-1234-1234-123456789012 itemIdstring Yes The ID of the list item to delete. Example: 1, 42, or 123
Parameter Type Description deletedboolean Whether the list item was deleted itemIdstring The ID of the deleted list item
Upload files to a SharePoint document library
Parameter Type Required Description siteIdstring No The ID of the SharePoint site driveIdstring No The ID of the document library (drive). If not provided, uses default drive. Example: b!abc123def456 folderPathstring No Optional folder path within the document library. Example: /Documents/Subfolder or /Shared Documents/Reports fileNamestring No Optional: override the uploaded file name. Example: report-2024.pdf filesfile[] Yes Files to upload to SharePoint
Parameter Type Description uploadedFilesarray Array of uploaded file objects ↳ id string The unique ID of the uploaded file ↳ name string The name of the uploaded file ↳ webUrl string The URL to access the file ↳ size number The size of the file in bytes ↳ createdDateTime string When the file was created ↳ lastModifiedDateTime string When the file was last modified fileCountnumber Number of files uploaded skippedFilesarray Files that were skipped before upload ↳ name string File name ↳ size number File size in bytes ↳ limit number Upload size limit in bytes ↳ reason string Reason the file was skipped skippedCountnumber Number of files skipped errorsarray Per-file upload errors ↳ name string File name ↳ error string Error message ↳ status number HTTP status from Microsoft Graph
Download a file from a SharePoint document library
Parameter Type Required Description driveIdstring Yes The ID of the document library (drive). Example: b!abc123def456 driveItemIdstring Yes The ID of the file (drive item) to download fileNamestring No Optional filename override (e.g., "report.pdf", "data.xlsx")
Parameter Type Description filefile Downloaded file stored in execution files
Get metadata for a file or folder in a SharePoint document library
Parameter Type Required Description driveIdstring Yes The ID of the document library (drive). Example: b!abc123def456 driveItemIdstring Yes The ID of the file or folder (drive item) to retrieve
Parameter Type Description driveItemobject Metadata for the SharePoint file or folder ↳ id string The unique ID of the drive item ↳ name string The name of the file or folder ↳ webUrl string The URL to access the item ↳ size number The size of the item in bytes ↳ createdDateTime string When the item was created ↳ lastModifiedDateTime string When the item was last modified ↳ file object Present if the item is a file (contains mimeType) ↳ folder object Present if the item is a folder (contains childCount) ↳ parentReference object Reference to the parent folder/drive
Delete a file (or folder) from a SharePoint document library
Parameter Type Required Description driveIdstring Yes The ID of the document library (drive). Example: b!abc123def456 driveItemIdstring Yes The ID of the file (drive item) to delete
Parameter Type Description deletedboolean Whether the file was deleted itemIdstring The ID of the deleted file