> ## Documentation Index > Fetch the complete documentation index at: https://docs.boxd.sh/llms.txt > Use this file to discover all available pages before exploring further. # SharePoint > SharePoint is a Microsoft platform for document management and intranets, enabling teams to collaborate, store, and organize content securely and effectively SharePoint is a Microsoft platform for document management and intranets, enabling teams to collaborate, store, and organize content securely and effectively `share-point` · **98 tools** · no triggers ## Connect it ```bash theme={"theme":"github-dark"} run auth share-point run auth share-point --scope team # shared with the organization ``` Or from the [Integrations page](https://app.boxd.sh/integrations) in the console. See [Connections](/guides/integrations/connections) for personal versus shared, and who may remove one. ## Use it ```bash theme={"theme":"github-dark"} run share-point # common commands run share-point --all # every command ``` ```ts theme={"theme":"github-dark"} import { sharePoint } from "@boxd/run"; ``` ## Common tools | Tool | What it does | | --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | | `create-list-item-by-id` | Tool to create a new item in a SharePoint list using the list's GUID. | | `get-file-by-server-relative-url` | DEPRECATED: Use GetSiteDriveItemByPath instead. Tool to fetch SharePoint file metadata (exists/permissions/URLs/UniqueId) given a server-relative... | | `get-site-by-hostname` | Retrieve SharePoint site information by hostname or URL. Returns site metadata including site ID, display name, URLs, and timestamps. | | `get-site-by-id` | Tool to retrieve information about a SharePoint site (web) by its unique identifier. | | `get-site-drive-item-by-path` | Tool to retrieve a file or folder by its server-relative path in a SharePoint site. | | `get-site-page-content` | Tool to retrieve modern SharePoint Site Pages content by reading list item fields. | | `get-site-root` | Retrieves metadata about the root web of a SharePoint site collection. | | `list-site-drives` | Tool to retrieve all document libraries (drives) in a SharePoint site. | | `list-sites` | Tool to retrieve all SharePoint sites accessible to the user. | | `list-subfolders-in-folder` | Tool to list immediate child folders within a SharePoint folder. | | `search-files` | Search for files across all SharePoint sites and OneDrive using Keyword Query Language. | | `update-file-item` | Tool to update metadata fields on a SharePoint file item via its ListItemAllFields. | | `update-list` | Tool to update properties of an existing SharePoint list. Use when you need to modify list metadata such as title, description, or settings like... | | `update-list-item` | Tool to update fields on an existing SharePoint list item. Use when you need to modify an item's properties with proper ETag concurrency control via MERGE. | | `update-site` | Tool to update properties of the current SharePoint site (web). | | `upload-from-url` | Tool to fetch a file from a URL and upload it to SharePoint. | | `validate-credential` | Validate SharePoint credentials by attempting to retrieve the current user information. | | Tool | What it does | | --------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `add-attachment-to-list-item` | Tool to add an attachment to a SharePoint list item. Use when you need to upload a binary file as an attachment to a specified list item. | | `add-field-link-to-content-type` | Tool to add a field link to a list content type. Use when you want to associate an existing list field with a content type. | | `add-role-assignment-to-item` | Tool to add a role assignment to a list item. Use when granting specific permissions to a user or group after breaking inheritance if needed. | | `add-role-assignment-to-list` | Tool to add a role assignment to a SharePoint list. Requires the list to have broken role inheritance first via... | | `break-role-inheritance-on-item` | Tool to break permission inheritance on a list item. Call this before adding new role assignments; adding assignments prior leaves the item still... | | `break-role-inheritance-on-list` | Breaks permission inheritance on a SharePoint list, allowing you to set unique permissions. | | `check-in-file` | Tool to check in a file. Use after uploading or editing a document and you're ready to finalize changes. | | `create-content-type` | Tool to create a new content type in SharePoint. Use when you need to define a custom content type with specific metadata structure for lists or libraries. | | `create-drive-item-sharing-link` | Tool to create a sharing link for a drive item in SharePoint or OneDrive. | | `create-list-field` | Tool to create a new field (column) in a SharePoint list. Use when you need to programmatically add a column after confirming the list GUID. | | `create-list-item-by-id` | Tool to create a new item in a SharePoint list using the list's GUID. | | `create-list-item-in-folder` | Tool to create a list item in a specific folder within a SharePoint list. | | `create-web` | Tool to create a new SharePoint subsite under the current site. | | `delete-drive-item-version-content` | Tool to delete content for a specific version of a drive item in SharePoint. | | `delete-file-item` | Deletes a file from a SharePoint document library permanently. | | `delete-folder` | Deletes a folder from a SharePoint document library. This action permanently removes the specified folder and moves it to the site's recycle bin. | | `delete-list` | Tool to delete a SharePoint list. Use when you need to remove a list by its GUID after confirming the correct list identifier. | | `delete-list-by-title` | Tool to delete a SharePoint list by its title. Use when you need to permanently remove a list and all its contents by specifying the list name. | | `delete-list-item` | Tool to delete a SharePoint list item. Use when you need to permanently remove an item by its ID. | | `delete-list-items` | Tool to delete multiple SharePoint list items in bulk. Use when you need to permanently remove multiple items by their IDs. | | `delete-recycle-bin-item-permanent` | Tool to permanently delete a SharePoint Recycle Bin item. Use after confirming the item's GUID to remove it irrevocably. | | `download-file-by-server-relative-url` | Tool to download a file by server-relative URL. Use when you need to fetch the raw bytes of a SharePoint file by its server-relative path. | | `ensure-user` | Ensures a user exists in a SharePoint site by their login name. | | `follow` | Follow a SharePoint user, document, site, or tag. Use to make the authenticated user follow a specified actor. | | `get-all-folders` | Tool to retrieve all folders in the SharePoint web. Use when you need to discover all available folders across the site. | | `get-changes` | Tool to retrieve changes from SharePoint list change log. Use when processing webhook notifications to get actual changes that occurred. | | `get-content-type` | Tool to retrieve a single SharePoint content type by its ID. | | `get-content-types` | Retrieves all content types from the current SharePoint site. | | `get-content-types-for-list` | Tool to retrieve all content types for a specific SharePoint list by GUID. | | `get-context-info` | Tool to retrieve SharePoint context information including the form digest value. | | `get-current-user` | Tool to retrieve the current user for the site. Use after authenticating to get the current SharePoint user. | | `get-drive-item-analytics` | Tool to get analytics for a SharePoint drive item. Use when you need to retrieve access statistics (view counts, unique viewers) for files or folders... | | `get-file-by-server-relative-url` | DEPRECATED: Use GetSiteDriveItemByPath instead. Tool to fetch SharePoint file metadata (exists/permissions/URLs/UniqueId) given a server-relative... | | `get-folder-by-server-relative-url` | DEPRECATED: Use SHARE\_POINT\_GET\_SITE\_DRIVE\_ITEM\_BY\_PATH instead. | | `get-group-users` | Retrieves all users who are members of a specified SharePoint group. | | `get-group-users-by-id` | Tool to retrieve all users in a specific SharePoint site group by group ID. | | `get-item-attachment-content` | Tool to download an attachment from a SharePoint list item. Use when retrieving the binary contents of a specific attachment after confirming the... | | `get-list-by-guid` | Tool to retrieve a SharePoint list by its GUID. Use when you need to fetch list metadata by its unique identifier. | | `get-list-by-title` | Tool to retrieve a SharePoint list by its title. Use when you need to fetch list metadata by title. | | `get-list-content-type-by-id` | Tool to retrieve a specific content type from a SharePoint list by its ID. | | `get-list-item-by-id` | Tool to retrieve a SharePoint list item by ID. Use when you need to fetch a specific item after knowing its ID. | | `get-list-items` | Tool to retrieve items from a SharePoint list. Use when you need to fetch list entries with optional OData parameters. | | `get-list-items-by-guid` | Tool to retrieve items from a SharePoint list using its GUID. | | `get-list-item-version` | Tool to retrieve a specific version of a SharePoint list item. | | `get-my-followed` | Tool to get entities the current user is following. Use when you need to retrieve followed users, documents, sites, or tags after authentication. | | `get-my-followers` | Retrieves the list of users who are following the authenticated user in SharePoint. | | `get-role-definitions` | Tool to list role definitions at the web level. Role definition IDs and names are scoped per web/site collection - never hard-code them, as admins... | | `get-site-by-hostname` | Retrieve SharePoint site information by hostname or URL. Returns site metadata including site ID, display name, URLs, and timestamps. | | `get-site-by-id` | Tool to retrieve information about a SharePoint site (web) by its unique identifier. | | `get-site-collection-info` | Tool to fetch site collection metadata (URL, ID, root web URI) only - not list item or document-level details. | | `get-site-drive-item-by-path` | Tool to retrieve a file or folder by its server-relative path in a SharePoint site. | | `get-site-page-content` | Tool to retrieve modern SharePoint Site Pages content by reading list item fields. | | `get-site-root` | Retrieves metadata about the root web of a SharePoint site collection. | | `get-user-effective-permissions-on-web` | Get a user's effective permissions on the current SharePoint site (Web). | | `get-webhook-subscription` | Tool to retrieve a specific webhook subscription by ID from a SharePoint list. | | `get-webhook-subscriptions` | Tool to retrieve all webhook subscriptions on a SharePoint list. | | `get-web-info` | Tool to retrieve information about the current SharePoint web (site) using REST API. | | `is-followed` | Tool to check if the current user is following a specified actor. | | `list-all-lists` | Retrieves all lists in the current SharePoint web/site. Use this action to discover available lists and document libraries on a SharePoint site, or... | | `list-drive-children` | Tool to list children (files and folders) in a SharePoint drive using REST API v2.0. | | `list-drive-recent-items` | Tool to list recently modified items in a SharePoint drive using Microsoft Graph API. | | `list-drives-rest-api` | Tool to retrieve drives using SharePoint REST API v2.0. Use when you need to list document libraries and drives from a SharePoint site using native... | | `list-files-in-folder` | Tool to list files within a SharePoint folder (non-recursive; does not enumerate subfolders). | | `list-item-attachments` | Tool to list all attachments for a SharePoint list item. Use when you need to retrieve filenames and server-relative URLs of each attachment after... | | `list-list-columns` | Tool to list all column definitions in a SharePoint list. Use when you need to retrieve field metadata including column names, types, and properties. | | `list-recycle-bin-items` | Tool to list items in the SharePoint Recycle Bin. Use when you need to retrieve deleted items and page through results. | | `list-site-drives` | Tool to retrieve all document libraries (drives) in a SharePoint site. | | `list-site-groups` | Tool to list SharePoint site groups for a site collection. Use when you need to see all groups and their settings before managing permissions. | | `list-sites` | Tool to retrieve all SharePoint sites accessible to the user. | | `list-site-users` | Tool to list users in the site collection. Results include person users, groups, and system principals by default; use filter 'PrincipalType eq 1' to... | | `list-subfolders-in-folder` | Tool to list immediate child folders within a SharePoint folder. | | `log-event` | Log custom usage analytics events in SharePoint for tracking user activities. | | `recycle-file` | Tool to move a file to the Recycle Bin. Use when you need to recycle a file after confirming its folder and filename paths. | | `recycle-list-item` | Tool to move a list item to the Recycle Bin. Use when you need to soft-delete an item but preserve the ability to restore it. | | `rename-folder` | Renames a SharePoint folder by updating its list item metadata. | | `render-list-data-as-stream` | Retrieve list items from SharePoint with rich metadata and formatting. | | `restore-drive-item-version` | Tool to restore a previous version of a SharePoint drive item. | | `restore-recycle-bin-item` | Tool to restore a SharePoint Recycle Bin item. Use when you need to recover a deleted item by providing its GUID. | | `search-files` | Search for files across all SharePoint sites and OneDrive using Keyword Query Language. | | `search-query` | Search SharePoint content using Keyword Query Language (KQL). | | `search-suggest` | Tool to get search query suggestions. Use when you need to provide autocomplete options for user search input. | | `sharepoint-check-out-file` | Tool to check out a file in a document library. Use when you need to lock a file before making changes. | | `sharepoint-create-folder` | Creates a new folder in SharePoint using the REST API. Returns `server_relative_url`; use it for downstream operations instead of constructing paths manually. | | `sharepoint-create-list` | Creates a new list in SharePoint using the REST API. Custom columns cannot be added at creation time; use SHARE\_POINT\_CREATE\_LIST\_FIELD with the... | | `sharepoint-create-list-item` | Creates a new item in a SharePoint list. Returns an `item_data` object containing `item_id`, `Title`, and timestamps on success. | | `sharepoint-create-user` | DEPRECATED: Use SHARE\_POINT\_ENSURE\_USER instead (supports email param directly). | | `sharepoint-find-user` | Searches for a user in the SharePoint site by email address and returns their profile information if found. | | `sharepoint-remove-user` | Removes a user from SharePoint. Returns success even if user doesn't exist or was never a member; check response fields `was_removed` (bool) and... | | `undo-checkout-file` | Tool to undo a file checkout, discarding any changes made while checked out. | | `update-content-type` | Tool to update a SharePoint content type's properties such as name, description, group, or hidden status. | | `update-drive-item` | Tool to update the properties of a drive item (file or folder) in SharePoint using SharePoint REST API. | | `update-file-item` | Tool to update metadata fields on a SharePoint file item via its ListItemAllFields. | | `update-list` | Tool to update properties of an existing SharePoint list. Use when you need to modify list metadata such as title, description, or settings like... | | `update-list-item` | Tool to update fields on an existing SharePoint list item. Use when you need to modify an item's properties with proper ETag concurrency control via MERGE. | | `update-site` | Tool to update properties of the current SharePoint site (web). | | `upload-file` | Tool to upload a file to a SharePoint document library or folder. | | `upload-from-url` | Tool to fetch a file from a URL and upload it to SharePoint. | | `validate-credential` | Validate SharePoint credentials by attempting to retrieve the current user information. | [Open SharePoint in the console →](https://app.boxd.sh/integrations/detail/share_point)