Connect AI agents to SharePoint

Scalekit connector

The SharePoint connector lets your AI agent act in each user's SharePoint account. Each user signs in to SharePoint once, and Scalekit stores and refreshes their tokens, so your agent never handles credentials. It comes with 52 tools.

Tools: 52
What they doRead · write · destructive: 23 · 22 · 723 read22 write7 destructive
Users sign in with: OAuth
OAuth app: Scalekit's or your own

Setup

npm install @scalekit-sdk/node dotenv

pip install scalekit-sdk-python python-dotenv

Set your credentials
Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.
.env
```
SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
SCALEKIT_CLIENT_ID=<your-client-id>
SCALEKIT_CLIENT_SECRET=<your-client-secret>
```
Create the SharePoint connection
In AgentKit > Connections, create a SharePoint connection. The name you give it is the connection_name your code passes. See Configure connections.
Scalekit credentials are available for SharePoint, so you don't need to register an OAuth app. To show your own app on the consent screen, use your own credentials instead.
Use your own OAuth app
Register your Scalekit environment with the SharePoint connector so Scalekit handles the authentication flow and token lifecycle for you. The connection name you create will be used to identify and invoke the connection programmatically. Then complete the configuration in your application as follows:
1. Set up auth redirects
  - In Scalekit dashboard, go to AgentKit > Connections > Create Connection. Find SharePoint and click Create. Copy the redirect URI. It will look like https://<SCALEKIT_ENVIRONMENT_URL>/sso/v1/oauth/<CONNECTION_ID>/callback.
  - Sign into https://entra.microsoft.com and go to Microsoft Entra ID → App registrations → New registration.
  - Enter a name for your app.
  - Under Supported account types, select Accounts in any organizational directory (Any Azure AD directory - Multitenant).
  - Under Redirect URI, select Web and paste the redirect URI from step 1. Click Register.
2. Get your client credentials
  - Go to Certificates & secrets → New client secret, set an expiry, and click Add. Copy the Value immediately.
  - From the Overview page, copy the Application (client) ID.
3. Add credentials in Scalekit
  - In Scalekit dashboard, go to AgentKit > Connections and open the connection you created.
  - Enter your credentials:
    
    Client ID (Application (client) ID from Azure)
    
    Client Secret (from Certificates & secrets)
    
    Permissions (scopes — see Microsoft Graph permissions reference)
  - Click Save.

Authorize a user and make your first call

Node.js
Python

1
import { ScalekitClient } from '@scalekit-sdk/node'
2
import 'dotenv/config'
3
import { createInterface } from 'node:readline/promises'
4

5
const scalekit = new ScalekitClient(
6
  process.env.SCALEKIT_ENVIRONMENT_URL,
7
  process.env.SCALEKIT_CLIENT_ID,
8
  process.env.SCALEKIT_CLIENT_SECRET,
9
)
10
const actions = scalekit.actions
11

12
const connector = 'sharepoint'
13
const identifier = 'user_123'
14

15
// Generate an authorization link for the user
16
const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
17
console.log('Authorize SharePoint:', link)
18
const rl = createInterface({ input: process.stdin, output: process.stdout })
19
await rl.question('Press Enter after authorizing...')
20
rl.close()
21

22
// Make your first call
23
const result = await actions.executeTool({
24
  connector,
25
  identifier,
26
  toolName: 'sharepoint_list_followed_sites',
27
  toolInput: {},
28
})
29
console.log(result)

npx tsx quickstart.mts

1
import os
2
from scalekit import ScalekitClient
3
from dotenv import load_dotenv
4
load_dotenv()
5

6
scalekit_client = ScalekitClient(
7
    env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
8
    client_id=os.getenv("SCALEKIT_CLIENT_ID"),
9
    client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
10
)
11
actions = scalekit_client.actions
12

13
connection_name = "sharepoint"
14
identifier = "user_123"
15

16
# Generate an authorization link for the user
17
link_response = actions.get_authorization_link(
18
    connection_name=connection_name,
19
    identifier=identifier,
20
)
21
print("Authorize SharePoint:", link_response.link)
22
input("Press Enter after authorizing...")
23

24
# Make your first call
25
result = actions.execute_tool(
26
    tool_input={},
27
    tool_name="sharepoint_list_followed_sites",
28
    connection_name=connection_name,
29
    identifier=identifier,
30
)
31
print(result)

python quickstart.py

Each user signs in once. See Authorize a user for the full flow and statuses.

Tools

Pass the exact name to execute_tool

Try in Playground Request a tool

sharepoint_download_fileDownload the binary content of a file from a SharePoint document library by its item ID.Read-only
Download SharePoint File
Download the binary content of a file from a SharePoint document library by its item ID. The response is the raw file bytes (not JSON). For text files this will be readable text; for binary files (images, Office documents) it will be binary data. Use the item ID from list or get drive item operations.
Inputs
item_idstringrequired
The unique drive item ID of the file to download from the SharePoint site's document library. Obtain item IDs from list drive items or search drive items operations.
site_idstringrequired
ID of the SharePoint site that contains the file. Use a site GUID, 'root', or the format '<hostname>:/sites/<path>'.
sharepoint_find_user_by_emailLook up an Azure Active Directory user by their email address (UPN).Read-only
Find User by Email
Look up an Azure Active Directory user by their email address (UPN). Returns the user's object ID, display name, and other profile properties. This is useful for resolving a user email to an object ID before adding them to a SharePoint site or group.
Inputs
emailstringrequired
The email address (user principal name) of the Azure AD user to look up. Example: 'john.doe@contoso.com'.
sharepoint_get_content_typeRetrieve a single content type defined in a SharePoint site by its ID, including its name, description, group, and whether it is a built-in type.Read-only
Get SharePoint Content Type
Retrieve a single content type defined in a SharePoint site by its ID, including its name, description, group, and whether it is a built-in type.
Inputs
content_type_idstringrequired
ID of the content type to retrieve.
site_idstringrequired
ID of the SharePoint site that contains the content type. Use a site GUID, 'root', or the format '<hostname>:/sites/<path>'.
selectstring
Comma-separated list of properties to return. Example: 'id,name,description,isBuiltIn'.
sharepoint_get_drive_itemGet metadata for a file or folder in a SharePoint document library — name, size, the file/folder facet, webUrl, timestamps, and more.Read-only
Get SharePoint Drive Item
Get metadata for a file or folder in a SharePoint document library — name, size, the file/folder facet, webUrl, timestamps, and more. Use this for a quick metadata lookup without downloading file content.
Inputs
item_idstringrequired
The unique drive item ID of the file or folder to retrieve. Obtain item IDs from list drive item children or search drive items operations.
site_idstringrequired
ID of the SharePoint site that contains the item. Use a site GUID, 'root', or the format '<hostname>:/sites/<path>'.
selectstring
Comma-separated list of drive item properties to return. Example: "id,name,size,webUrl" reduces response payload.
sharepoint_get_listRetrieve a specific SharePoint list by its ID within a site.Read-only
Get SharePoint List
Retrieve a specific SharePoint list by its ID within a site. Optionally expand related resources such as columns and items to retrieve list metadata in a single call.
Inputs
list_idstringrequired
ID or name of the SharePoint list to retrieve. Can be the list GUID or the list's display name (URL-encoded).
site_idstringrequired
ID of the SharePoint site containing the list. Use a site GUID, 'root', or the format '<hostname>:/sites/<path>'.
expandstring
Comma-separated list of related resources to expand. Example: 'columns,items' to include column definitions and list items in the response.
sharepoint_get_list_itemRetrieve a single item from a SharePoint list by its item ID.Read-only
Get SharePoint List Item
Retrieve a single item from a SharePoint list by its item ID. Use '$expand=fields' to include the column values in the response.
Inputs
item_idstringrequired
ID of the list item to retrieve. This is the numeric or GUID identifier of the item within the list.
list_idstringrequired
ID of the SharePoint list that contains the item. Use the list GUID or display name.
site_idstringrequired
ID of the SharePoint site that contains the list. Use a site GUID, 'root', or the format '<hostname>:/sites/<path>'.
expandstring
Comma-separated list of related resources to expand. Default is 'fields' to include column values. Example: 'fields'.default fields
selectstring
Comma-separated list of properties to return. Example: 'id,createdDateTime,fields'.
sharepoint_get_search_suggestionsGet search query suggestions for SharePoint content using the Microsoft Search beta API.Read-only
Get SharePoint Search Suggestions
Get search query suggestions for SharePoint content using the Microsoft Search beta API. Returns autocomplete suggestions based on the provided search text to help users refine their queries.
Inputs
textstringrequired
The partial search term for which to retrieve suggestions. Example: 'proj' returns suggestions like 'project plan', 'project budget'.
sharepoint_get_siteRetrieve properties of a SharePoint site by its ID.Read-only
Get SharePoint Site
Retrieve properties of a SharePoint site by its ID. Use 'root' for the tenant root site, a GUID for a specific site, or the format '<hostname>:/sites/<path>' (e.g., 'contoso.sharepoint.com:/sites/Marketing').
Inputs
site_idstringrequired
ID of the SharePoint site to retrieve. Use 'root' for the tenant root site, a site GUID, or the format '<hostname>:/sites/<path>' (e.g., 'contoso.sharepoint.com:/sites/Marketing').
sharepoint_get_site_pageRetrieve a single modern site page (sitePage) from a SharePoint site by its ID, including its title, layout, and publishing state.Read-only
Get SharePoint Site Page
Retrieve a single modern site page (sitePage) from a SharePoint site by its ID, including its title, layout, and publishing state. Use $expand=canvasLayout to also retrieve its web part content.
Inputs
page_idstringrequired
ID of the site page to retrieve.
site_idstringrequired
ID of the SharePoint site that contains the page. Use a site GUID, 'root', or the format '<hostname>:/sites/<path>'.
expandstring
Comma-separated list of relationships to expand inline, e.g. 'canvasLayout' to include the page's web part layout.
sharepoint_get_site_permissionRetrieve a single permission entry (role assignment) on a SharePoint site by its permission ID, showing the granted roles and the identity they were granted to.Read-only
Get SharePoint Site Permission
Retrieve a single permission entry (role assignment) on a SharePoint site by its permission ID, showing the granted roles and the identity they were granted to.
Inputs
permission_idstringrequired
The ID of the permission entry to retrieve. Obtain this from the list permissions tool.
site_idstringrequired
ID of the SharePoint site that the permission belongs to. Use a site GUID, 'root', or the format '<hostname>:/sites/<path>'.
sharepoint_list_content_typesList all content types defined in a SharePoint site.Read-only
List SharePoint Content Types
List all content types defined in a SharePoint site. Supports OData filtering, field selection, and pagination via $top. Content types define the metadata schema for lists and libraries.
Inputs
site_idstringrequired
ID of the SharePoint site whose content types to retrieve. Use a site GUID, 'root', or the format '<hostname>:/sites/<path>'.
filterstring
OData filter expression to narrow results. Example: "isBuiltIn eq false" to return only custom content types.
selectstring
Comma-separated list of properties to return for each content type. Example: 'id,name,description,isBuiltIn'.
topinteger
Maximum number of content types to return per page. Default is determined by the API.
sharepoint_list_drive_item_childrenList the immediate children (files and folders) of a folder in a SharePoint document library.Read-only
List SharePoint Drive Item Children
List the immediate children (files and folders) of a folder in a SharePoint document library. Use item_id 'root' to browse the document library's root folder.
Inputs
item_idstringrequired
The unique drive item ID of the folder to list. Use 'root' to list the document library's root folder.
site_idstringrequired
ID of the SharePoint site that contains the folder. Use a site GUID, 'root', or the format '<hostname>:/sites/<path>'.
selectstring
Comma-separated list of drive item properties to return per child. Example: "id,name,size,webUrl" reduces response payload.
topinteger
Maximum number of children to return per page. Default is determined by the API.
sharepoint_list_drivesList all drives (document libraries) within a specific SharePoint site.Read-only
List SharePoint Site Drives
List all drives (document libraries) within a specific SharePoint site. Returns drive IDs, names, and types. Use the returned drive IDs with other drive item tools to access files within that library. To list all drives accessible to the signed-in user across all sites, use onedrive_list_drives instead.
Inputs
site_idstringrequired
The unique ID of the SharePoint site whose drives to list. Obtain site IDs from sharepoint_get_site or sharepoint_list_sites.
$selectstring
Comma-separated list of drive properties to return. Example: "id,name,driveType" reduces response payload.
sharepoint_list_file_versionsList all versions of a file in a SharePoint document library.Read-only
List SharePoint File Versions
List all versions of a file in a SharePoint document library. Returns version metadata including version number, last modified time, size, and the user who made each change.
Inputs
item_idstringrequired
The unique drive item ID of the file whose version history to retrieve. Obtain item IDs from list drive items or get drive item operations.
site_idstringrequired
ID of the SharePoint site that contains the file. Use a site GUID, 'root', or the format '<hostname>:/sites/<path>'.
topinteger
Maximum number of versions to return per page. Default is determined by the API.
sharepoint_list_followed_sitesList all SharePoint sites that the signed-in user is following.Read-only
List Followed Sites
List all SharePoint sites that the signed-in user is following. Returns site IDs, names, URLs, and descriptions. Use the returned site IDs with sharepoint_get_site or sharepoint_list_drives to explore the site's content.
Inputs
This tool takes no inputs.
sharepoint_list_list_fieldsList all column definitions (fields) for a SharePoint list.Read-only
List SharePoint List Fields
List all column definitions (fields) for a SharePoint list. Returns metadata for each column including its name, type, and configuration. Supports OData filtering, field selection, and pagination.
Inputs
list_idstringrequired
ID of the SharePoint list whose column definitions to retrieve. Use the list GUID or display name.
site_idstringrequired
ID of the SharePoint site that contains the list. Use a site GUID, 'root', or the format '<hostname>:/sites/<path>'.
filterstring
OData filter expression to narrow results. Example: "hidden eq false" to return only visible columns.
selectstring
Comma-separated list of properties to return for each column. Example: 'id,name,displayName,columnGroup,hidden'.
topinteger
Maximum number of columns to return per page. Default is determined by the API.
sharepoint_list_list_itemsRetrieve items from a SharePoint list.Read-only
List SharePoint List Items
Retrieve items from a SharePoint list. Supports OData filtering, field selection, ordering, pagination, and expanding related resources such as fields (column values).
Inputs
list_idstringrequired
ID of the SharePoint list whose items to retrieve. Use the list GUID or display name.
site_idstringrequired
ID of the SharePoint site that contains the list. Use a site GUID, 'root', or the format '<hostname>:/sites/<path>'.
expandstring
Comma-separated list of related resources to expand. Use 'fields' to include the column values for each item. Example: 'fields'.
filterstring
OData filter expression to narrow results. Example: "fields/Status eq 'Active'" to return only active items.
orderbystring
OData orderby expression to sort results. Example: 'fields/Title asc' or 'createdDateTime desc'.
selectstring
Comma-separated list of properties to return for each item. Example: 'id,createdDateTime,fields'.
skipinteger
Number of items to skip for pagination. Use with $top to page through results.
topinteger
Maximum number of items to return per page. Default is determined by the API.
sharepoint_list_listsList all lists in a SharePoint site.Read-only
List SharePoint Lists
List all lists in a SharePoint site. Supports OData filtering, field selection, pagination, and expansion of related resources such as columns and items.
Inputs
site_idstringrequired
ID of the SharePoint site whose lists to retrieve. Use a site GUID, 'root', or the format '<hostname>:/sites/<path>'.
expandstring
Comma-separated list of related resources to expand. Example: 'columns,items' to include column definitions and list items.
filterstring
OData filter expression to narrow results. Example: "list/template eq 'documentLibrary'" to return only document libraries.
selectstring
Comma-separated list of properties to return for each list. Example: 'id,displayName,description,webUrl'.
topinteger
Maximum number of lists to return per page. Default is determined by the API.
sharepoint_list_site_membersList all permission entries (members) for a SharePoint site.Read-only
List SharePoint Site Members
List all permission entries (members) for a SharePoint site. Returns users and groups with their assigned roles. Supports OData pagination and expansion of related identity resources.
Inputs
site_idstringrequired
ID of the SharePoint site whose members (permissions) to retrieve. Use a site GUID, 'root', or the format '<hostname>:/sites/<path>'.
expandstring
Comma-separated list of related resources to expand. Example: 'grantedToIdentities' to include the full identity objects for each permission entry.
topinteger
Maximum number of permission entries to return per page. Default is determined by the API.
sharepoint_list_site_pagesList the modern site pages (sitePage objects) in a SharePoint site's Site Pages library, sorted alphabetically by name.Read-only
List SharePoint Site Pages
List the modern site pages (sitePage objects) in a SharePoint site's Site Pages library, sorted alphabetically by name. Supports OData query options for field selection, expansion, and pagination.
Inputs
site_idstringrequired
ID of the SharePoint site whose pages to list. Use a site GUID, 'root', or the format '<hostname>:/sites/<path>'.
expandstring
Comma-separated list of relationships to expand inline, e.g. 'canvasLayout' to include the page's web part layout.
selectstring
Comma-separated list of properties to return for each page. Example: 'id,name,title,webUrl'.
topinteger
Maximum number of pages to return per page of results.
sharepoint_list_site_permissionsList the permission entries (role assignments) granted on a SharePoint site, showing which users, groups, or applications have read, write, or owner access.Read-only
List SharePoint Site Permissions
List the permission entries (role assignments) granted on a SharePoint site, showing which users, groups, or applications have read, write, or owner access.
Inputs
site_idstringrequired
ID of the SharePoint site whose permissions to list. Use a site GUID, 'root', or the format '<hostname>:/sites/<path>'.
sharepoint_list_sitesList SharePoint sites accessible to the signed-in user.Read-only
List SharePoint Sites
List SharePoint sites accessible to the signed-in user. Use the search parameter to find sites by name or keyword. Defaults to returning all sites (search=*). Supports OData query options for pagination and field selection.
Inputs
$selectstring
Comma-separated list of properties to return for each site. Example: 'id,displayName,webUrl,description'.
$topinteger
Maximum number of sites to return per page (1-999). Default is determined by the API.
searchstring
Search keyword to filter sites by name or description. Use '*' to return all accessible sites. Example: 'Marketing' or 'project'.default *
sharepoint_searchSearch across SharePoint sites, lists, drive items, and list items using the Microsoft Search API.Read-only
Search SharePoint
Search across SharePoint sites, lists, drive items, and list items using the Microsoft Search API. Supports full-text keyword search and KQL (Keyword Query Language). Returns up to 25 results by default.
Inputs
querystringrequired
The search query string to find matching SharePoint content. Supports keyword search and KQL (Keyword Query Language). Example: 'project plan' or 'site:https://contoso.sharepoint.com/sites/Marketing'.
entity_typesarray
Array of entity types to search across. Valid values: driveItem, listItem, site, list, drive, externalItem. Default is ['driveItem', 'listItem'].
frominteger
Zero-based index of the first result to return, used for pagination. Default is 0 (start from the first result).default 0
sizeinteger
Number of results to return per page. Default is 25, maximum is 200.default 25
sharepoint_add_group_memberAdd an Azure AD user to a Microsoft 365 group (including SharePoint site groups) by providing the group ID and the user's object ID.Write
Add Member to SharePoint Group
Add an Azure AD user to a Microsoft 365 group (including SharePoint site groups) by providing the group ID and the user's object ID. This uses the Graph API directoryObjects reference endpoint to create the membership link.
Inputs
group_idstringrequired
The Azure AD object ID of the group to add the member to. Example: '7d8a5b3c-1234-5678-abcd-ef0123456789'.
user_idstringrequired
The Azure AD object ID of the user to add to the group. Use the find_user_by_email tool to resolve an email to an object ID. Example: 'aaaabbbb-1234-5678-abcd-ef0123456789'.
sharepoint_add_role_assignmentGrant a user or group a role (read, write, or owner) on a SharePoint site by adding a permission entry.Write
Add SharePoint Site Role Assignment
Grant a user or group a role (read, write, or owner) on a SharePoint site by adding a permission entry. Provide either user_id or group_id (not both). The roles array should contain one or more of: 'read', 'write', 'owner'.
Inputs
rolesarrayrequired
Array of roles to grant. Valid values are 'read', 'write', and 'owner'. Example: ["write"] grants write (contribute) permission.
site_idstringrequired
ID of the SharePoint site on which to add the permission. Use a site GUID, 'root', or the format '<hostname>:/sites/<path>'.
group_idstring
Azure AD group object ID to grant the role to. Provide either user_id or group_id — not both. Example: '7d8a5b3c-1234-5678-abcd-ef0123456789'.
user_idstring
Azure AD user object ID to grant the role to. Provide either user_id or group_id — not both. Example: 'aaaabbbb-1234-5678-abcd-ef0123456789'.
sharepoint_checkin_fileCheck in a checked-out file in a SharePoint document library to make the version available to others.Write
Check In SharePoint File
Check in a checked-out file in a SharePoint document library to make the version available to others. Optionally provide a comment describing the changes and specify the check-in type. Requires the file to be checked out first.
Inputs
item_idstringrequired
The unique drive item ID of the file to check in. The file must currently be checked out. Obtain item IDs from list drive items or get drive item operations.
site_idstringrequired
ID of the SharePoint site that contains the file. Use a site GUID, 'root', or the format '<hostname>:/sites/<path>'.
check_in_asstring
The type of check-in to perform. 'published' makes the version visible to all users. 'unspecified' (default) lets the server decide based on document library configuration.one of publishedunspecifieddefault unspecified
commentstring
An optional comment to associate with the checked-in version, describing the changes made.
sharepoint_checkout_fileCheck out a file in a SharePoint document library to prevent others from editing it while you make changes.Write
Check Out SharePoint File
Check out a file in a SharePoint document library to prevent others from editing it while you make changes. The file must be checked back in using the check-in operation when editing is complete.
Inputs
item_idstringrequired
The unique drive item ID of the file to check out. Obtain item IDs from list drive items or get drive item operations.
site_idstringrequired
ID of the SharePoint site that contains the file. Use a site GUID, 'root', or the format '<hostname>:/sites/<path>'.
sharepoint_copy_drive_itemCreate a copy of a file or folder (including its children) in a SharePoint document library.Write
Copy SharePoint Drive Item
Create a copy of a file or folder (including its children) in a SharePoint document library. This is an asynchronous operation: Microsoft Graph returns 202 Accepted immediately with a monitor URL in the Location response header, and the copy completes in the background.
Inputs
item_idstringrequired
The unique drive item ID of the file or folder to copy. Obtain item IDs from list drive item children or search drive items operations.
new_parent_idstringrequired
Drive item ID of the destination parent folder for the copy. Use 'root' to copy into the document library's root.
site_idstringrequired
ID of the SharePoint site that contains the item to copy. Use a site GUID, 'root', or the format '<hostname>:/sites/<path>'.
new_namestring
Optional name to give the copy. If omitted, the copy keeps the source item's name.
sharepoint_create_folderCreate a new folder inside a SharePoint document library folder.Write
Create SharePoint Folder
Create a new folder inside a SharePoint document library folder. Use parent_id 'root' to create the folder at the document library's root.
Inputs
namestringrequired
Name of the folder to create.
parent_idstringrequired
Drive item ID of the parent folder in the SharePoint document library where the new folder will be created. Use 'root' to create it at the library root.
site_idstringrequired
ID of the SharePoint site that contains the document library. Use a site GUID, 'root', or the format '<hostname>:/sites/<path>'.
conflict_behaviorstring
Behavior when a folder with the same name already exists at the destination. 'fail' returns an error, 'replace' overwrites the existing item, 'rename' creates a new folder with an incremented name.one of failreplacerenamedefault replace
sharepoint_create_listCreate a new list in a SharePoint site.Write
Create SharePoint List
Create a new list in a SharePoint site. Specify a display name and optionally a template type (e.g., genericList, documentLibrary, events) and description. Returns the newly created list.
Inputs
display_namestringrequired
Display name for the new list. Example: 'Project Tasks'.
site_idstringrequired
ID of the SharePoint site in which to create the list. Use a site GUID, 'root', or the format '<hostname>:/sites/<path>'.
descriptionstring
Optional description for the new list. Example: 'Tracks project tasks and assignments.'
templatestring
SharePoint list template to use. Valid values: genericList (default), documentLibrary, survey, links, announcements, contacts, events, tasks.one of genericListdocumentLibrarysurveylinksannouncementscontactseventstasksdefault genericList
sharepoint_create_list_fieldAdd a new column (field) to a SharePoint list.Write
Create SharePoint List Field
Add a new column (field) to a SharePoint list. Specify the internal column name, column type (text, number, boolean, dateTime, choice, hyperlinkOrPicture, personOrGroup), and optionally a display name and description. The tool emits the appropriate Microsoft Graph column definition block for the chosen type.
Inputs
list_idstringrequired
ID of the SharePoint list to which the column will be added. Use the list GUID or display name.
namestringrequired
Internal name for the new column. Used as the key in item fields objects. Must be unique within the list and contain no spaces (use camelCase or underscores). Example: 'taskStatus'.
site_idstringrequired
ID of the SharePoint site that contains the list. Use a site GUID, 'root', or the format '<hostname>:/sites/<path>'.
column_typestring
Type of column to create. Determines which Microsoft Graph column configuration block is used. Valid values: text (single or multi-line text), number (numeric values), boolean (yes/no checkbox), dateTime (date and/or time), choice (dropdown or radio from a fixed list), hyperlinkOrPicture (URL or image), personOrGroup (people picker). Default: text.one of textnumberbooleandateTimechoicehyperlinkOrPicturepersonOrGroupdefault text
descriptionstring
Optional description for the new column. Appears as a tooltip or hint in the SharePoint list UI.
display_namestring
Human-readable display name for the column as shown in the SharePoint list UI. If omitted, the internal name is used.
sharepoint_create_list_itemCreate a new item in a SharePoint list.Write
Create SharePoint List Item
Create a new item in a SharePoint list. Provide a 'fields' object whose keys are the internal column names and whose values are the field data. The required 'Title' field sets the item's primary display name.
Inputs
fieldsobjectrequired
Object containing the field values for the new item. Keys are internal column names (e.g., 'Title', 'Status', 'DueDate'). Example: {"Title": "New Task", "Status": "In Progress"}.
list_idstringrequired
ID of the SharePoint list in which to create the item. Use the list GUID or display name.
site_idstringrequired
ID of the SharePoint site that contains the list. Use a site GUID, 'root', or the format '<hostname>:/sites/<path>'.
sharepoint_create_site_pageCreate a new modern site page (sitePage) in a SharePoint site's Site Pages library.Write
Create SharePoint Site Page
Create a new modern site page (sitePage) in a SharePoint site's Site Pages library. The page is created as a draft; use the Publish Site Page tool to make it visible to other users.
Inputs
namestringrequired
File name for the new page, including the .aspx extension. Example: 'project-update.aspx'.
site_idstringrequired
ID of the SharePoint site in which to create the page. Use a site GUID, 'root', or the format '<hostname>:/sites/<path>'.
page_layoutstring
Layout of the new page. 'article' is a standard content page; 'home' designates it as the site's home page.one of articlehomedefault article
titlestring
Display title shown at the top of the page. Defaults to the name without its extension if omitted.
sharepoint_create_subsiteCreate a new subsite under an existing SharePoint site using the Microsoft Graph beta API.Write
Create SharePoint Subsite
Create a new subsite under an existing SharePoint site using the Microsoft Graph beta API. Requires the parent site ID and display name. Optionally specify a description and web template (e.g., 'STS#0' for a team site).
Inputs
display_namestringrequired
Display name of the new subsite. Example: 'Marketing Q3 Campaign'.
parent_site_idstringrequired
ID of the parent SharePoint site under which the subsite will be created. Use a site GUID or 'root' for the tenant root site.
descriptionstring
Optional description for the new subsite. Example: 'Site for the Q3 marketing campaign team.'
web_templatestring
SharePoint web template to use when creating the subsite. Common values: 'STS#0' (Team Site), 'BLOG#0' (Blog Site), 'BDR#0' (Document Center). Defaults to the API default if not specified.
sharepoint_follow_documentFollow a SharePoint document or OneDrive file so it appears in the signed-in user's followed documents list.Write
Follow SharePoint Document
Follow a SharePoint document or OneDrive file so it appears in the signed-in user's followed documents list. Provide the drive item ID of the document to follow.
Inputs
item_idstringrequired
The ID of the drive item (document) to follow. Example: '01BYE5RZ6QN3ZWBTUFOFD3GSPGOHDJD36K'.
sharepoint_move_drive_itemMove a file or folder to a new parent folder in a SharePoint document library, by updating its parentReference.Write
Move SharePoint Drive Item
Move a file or folder to a new parent folder in a SharePoint document library, by updating its parentReference. Optionally rename the item in the same call.
Inputs
item_idstringrequired
The unique drive item ID of the file or folder to move. Obtain item IDs from list drive item children or search drive items operations.
new_parent_idstringrequired
Drive item ID of the destination parent folder. Use 'root' to move the item to the document library's root.
site_idstringrequired
ID of the SharePoint site that contains the item. Use a site GUID, 'root', or the format '<hostname>:/sites/<path>'.
new_namestring
Optional new name to give the item as part of the move. If omitted, the item keeps its current name.
sharepoint_publish_site_pagePublish a draft or checked-out modern site page in a SharePoint site, making its latest changes visible to other users.Write
Publish SharePoint Site Page
Publish a draft or checked-out modern site page in a SharePoint site, making its latest changes visible to other users.
- Idempotent
Inputs
page_idstringrequired
ID of the site page to publish.
site_idstringrequired
ID of the SharePoint site that contains the page. Use a site GUID, 'root', or the format '<hostname>:/sites/<path>'.
sharepoint_restore_recycled_itemRestore a previously recycled (soft-deleted) item in a SharePoint document library.Write
Restore Recycled SharePoint Item
Restore a previously recycled (soft-deleted) item in a SharePoint document library. Optionally specify a new parent folder and/or new name for the restored item. If neither is provided, the item is restored to its original location.
Inputs
item_idstringrequired
The unique drive item ID of the recycled item to restore. Obtain item IDs from list drive items or search recycled items operations.
site_idstringrequired
ID of the SharePoint site that contains the recycled item. Use a site GUID, 'root', or the format '<hostname>:/sites/<path>'.
new_namestring
Optional new filename to give the restored item. If omitted, the item retains its original name.
new_parent_idstring
Optional drive item ID of the parent folder to restore the item into. If omitted, the item is restored to its original parent location.
sharepoint_subscribe_webhookCreate a webhook subscription to receive change notifications for a SharePoint list or site resource.Write
Subscribe to SharePoint Webhook
Create a webhook subscription to receive change notifications for a SharePoint list or site resource. When changes matching the specified change type occur, Graph will POST a notification to your notification URL. Note: the notification URL must be HTTPS and must be pre-approved/allowlisted in the backend. Subscriptions expire within 3 days and must be renewed before expiry.
Inputs
expiration_date_timestringrequired
The ISO 8601 datetime when the subscription expires. Maximum is 3 days from now for SharePoint resources. Example: '2026-06-20T12:00:00Z'.
notification_urlstringrequired
The HTTPS URL that will receive notifications when changes occur. Must be publicly accessible and pre-approved by the backend. Example: 'https://webhook.example.com/notifications'.
resourcestringrequired
The Graph API resource path to monitor for changes. For SharePoint lists use: 'sites/{site_id}/lists/{list_id}'. For an entire site drive: 'sites/{site_id}/drive/root'. Example: 'sites/contoso.sharepoint.com,abc123,def456/lists/list-guid-here'.
change_typestring
The type of change to subscribe to. Valid values: 'created', 'updated', 'deleted', 'all'. Default is 'updated'.one of createdupdateddeletedalldefault updated
client_statestring
Optional secret string included in the notification payload so you can verify it came from Microsoft Graph. Max 128 characters. Example: 'my-secret-key-12345'.
sharepoint_unfollow_documentStop following a SharePoint document or OneDrive file.Write
Unfollow SharePoint Document
Stop following a SharePoint document or OneDrive file. The document will be removed from the signed-in user's followed documents list. Provide the drive item ID of the document to unfollow.
Inputs
item_idstringrequired
The ID of the drive item (document) to unfollow. Example: '01BYE5RZ6QN3ZWBTUFOFD3GSPGOHDJD36K'.
sharepoint_update_listUpdate the display name or description of an existing SharePoint list.Write
Update SharePoint List
Update the display name or description of an existing SharePoint list. Provide the site ID, list ID, and at least one of display_name or description to update.
- Idempotent
Inputs
list_idstringrequired
ID or name of the SharePoint list to update. Can be the list GUID or the list's display name.
site_idstringrequired
ID of the SharePoint site containing the list. Use a site GUID, 'root', or the format '<hostname>:/sites/<path>'.
descriptionstring
New description for the SharePoint list. Example: 'Updated task list for Q3 project.'
display_namestring
New display name for the SharePoint list. Example: 'Q3 Project Tasks'.
sharepoint_update_list_fieldUpdate the metadata of an existing SharePoint list column (field).Write
Update SharePoint List Field
Update the metadata of an existing SharePoint list column (field). Supports updating the display name, description, hidden visibility, and read-only status. Only provided fields are modified.
- Idempotent
Inputs
column_idstringrequired
ID of the column to update. Use the column GUID returned by the list fields endpoint.
list_idstringrequired
ID of the SharePoint list that contains the column. Use the list GUID or display name.
site_idstringrequired
ID of the SharePoint site that contains the list. Use a site GUID, 'root', or the format '<hostname>:/sites/<path>'.
descriptionstring
New description for the column. Appears as a tooltip or hint in the SharePoint list UI.
display_namestring
New display name for the column as shown in the SharePoint list UI.
hiddenboolean
Whether the column should be hidden from the default list view. Set to true to hide or false to show.
read_onlyboolean
Whether the column should be read-only. Set to true to prevent users from editing the column value.
sharepoint_update_list_itemUpdate the field values of an existing SharePoint list item.Write
Update SharePoint List Item
Update the field values of an existing SharePoint list item. PATCH the /fields subpath with a flat object of column name-value pairs. Only the fields provided are updated; omitted fields remain unchanged.
- Idempotent
Inputs
fieldsobjectrequired
Object containing the field values to update. Keys are internal column names. Only provided fields are changed. Example: {"Title": "Updated Title", "Status": "Done"}.
item_idstringrequired
ID of the list item to update. This is the numeric or string identifier of the item within the list.
list_idstringrequired
ID of the SharePoint list that contains the item. Use the list GUID or display name.
site_idstringrequired
ID of the SharePoint site that contains the list. Use a site GUID, 'root', or the format '<hostname>:/sites/<path>'.
sharepoint_update_siteUpdate the display name or description of an existing SharePoint site.Write
Update SharePoint Site
Update the display name or description of an existing SharePoint site. Provide the site ID and at least one of display_name or description to update.
- Idempotent
Inputs
site_idstringrequired
ID of the SharePoint site to update. Use a site GUID, 'root', or the format '<hostname>:/sites/<path>'.
descriptionstring
New description for the SharePoint site. Example: 'Official site for the Marketing department.'
display_namestring
New display name for the SharePoint site. Example: 'Marketing Hub 2024'.
sharepoint_upload_fileCreate an upload session for uploading a file to a SharePoint document library.Write
Upload File to SharePoint (Create Upload Session)
Create an upload session for uploading a file to a SharePoint document library. Returns an upload URL that the caller uses to upload the file content in subsequent PUT requests. This session-based approach supports files of any size. Required: site_id, parent_id (use 'root' for the library root folder), and filename.
Inputs
filenamestringrequired
Name of the file to upload including its extension. Example: 'report-Q4.xlsx'. This will be the filename in SharePoint.
parent_idstringrequired
Drive item ID of the parent folder in the SharePoint document library where the file will be uploaded. Use 'root' to upload to the library root folder, or a folder item ID from a list drive items operation.
site_idstringrequired
ID of the SharePoint site that contains the document library. Use a site GUID, 'root', or the format '<hostname>:/sites/<path>'.
conflict_behaviorstring
Behavior when a file with the same name already exists at the destination. 'fail' returns an error, 'replace' overwrites the existing file, 'rename' creates a new file with an incremented name.one of failreplacerenamedefault replace
sharepoint_delete_listPermanently delete a SharePoint list from a site.Destructive
Delete SharePoint List
Permanently delete a SharePoint list from a site. This action is irreversible and removes the list along with all its items and metadata.
Inputs
list_idstringrequired
ID of the SharePoint list to delete. Use the list GUID or the list's display name.
site_idstringrequired
ID of the SharePoint site that contains the list. Use a site GUID, 'root', or the format '<hostname>:/sites/<path>'.
sharepoint_delete_list_fieldPermanently delete a column (field) from a SharePoint list.Destructive
Delete SharePoint List Field
Permanently delete a column (field) from a SharePoint list. This action is irreversible and removes the column definition and all data stored in that column for every list item.
Inputs
column_idstringrequired
ID of the column to delete. Use the column GUID returned by the list fields endpoint.
list_idstringrequired
ID of the SharePoint list that contains the column. Use the list GUID or display name.
site_idstringrequired
ID of the SharePoint site that contains the list. Use a site GUID, 'root', or the format '<hostname>:/sites/<path>'.
sharepoint_delete_list_itemPermanently delete an item from a SharePoint list.Destructive
Delete SharePoint List Item
Permanently delete an item from a SharePoint list. This action is irreversible and removes the item and all its field data.
Inputs
item_idstringrequired
ID of the list item to delete. This is the numeric or string identifier of the item within the list.
list_idstringrequired
ID of the SharePoint list that contains the item. Use the list GUID or display name.
site_idstringrequired
ID of the SharePoint site that contains the list. Use a site GUID, 'root', or the format '<hostname>:/sites/<path>'.
sharepoint_delete_role_assignmentRemove a specific permission entry from a SharePoint site by deleting its permission ID.Destructive
Delete SharePoint Site Role Assignment
Remove a specific permission entry from a SharePoint site by deleting its permission ID. This permanently removes the granted access for the user or group associated with that permission.
- Idempotent
Inputs
permission_idstringrequired
The ID of the permission entry to delete. Obtain this from the list permissions endpoint. Example: 'aGVyZUlzVGhlV2F5VGhlUG93ZXJJcw'.
site_idstringrequired
ID of the SharePoint site from which to remove the permission. Use a site GUID, 'root', or the format '<hostname>:/sites/<path>'.
sharepoint_delete_webhookDelete a Microsoft Graph change notification subscription (webhook) by its subscription ID.Destructive
Delete SharePoint Webhook Subscription
Delete a Microsoft Graph change notification subscription (webhook) by its subscription ID. After deletion, no further notifications will be sent to the registered notification URL for this subscription.
- Idempotent
Inputs
subscription_idstringrequired
The ID of the subscription to delete. Obtain this from the create subscription response or by listing subscriptions. Example: 'abc123de-4567-89ab-cdef-0123456789ab'.
sharepoint_recycle_itemMove a file or folder in a SharePoint document library to the site recycle bin.Destructive
Recycle SharePoint Item
Move a file or folder in a SharePoint document library to the site recycle bin. This is a soft-delete — the item can be restored from the recycle bin. Permanent deletion requires a separate operation on the recycle bin itself.
- Idempotent
Inputs
item_idstringrequired
The unique drive item ID of the file or folder to move to the recycle bin. Obtain item IDs from list drive items or search drive items operations.
site_idstringrequired
ID of the SharePoint site that contains the item to recycle. Use a site GUID, 'root', or the format '<hostname>:/sites/<path>'.
sharepoint_remove_group_memberRemove a user from an Azure AD group (including Microsoft 365 and SharePoint site groups) by providing the group ID and user object ID.Destructive
Remove Member from SharePoint Group
Remove a user from an Azure AD group (including Microsoft 365 and SharePoint site groups) by providing the group ID and user object ID. This permanently removes the membership.
- Idempotent
Inputs
group_idstringrequired
The Azure AD object ID of the group to remove the member from. Example: '7d8a5b3c-1234-5678-abcd-ef0123456789'.
user_idstringrequired
The Azure AD object ID of the user to remove from the group. Example: 'aaaabbbb-1234-5678-abcd-ef0123456789'.

Workflows

Proxy API call

Node.js
Python

const result = await actions.request({
  connectionName: 'sharepoint',
  identifier: 'user_123',
  path: '/v1.0/me/sites',
  method: 'GET',
});
console.log(result);

result = actions.request(
    connection_name='sharepoint',
    identifier='user_123',
    path="/v1.0/me/sites",
    method="GET"
)
print(result)

Download a file

Fetch file metadata via the Scalekit proxy to get a pre-authenticated download URL, then stream the file directly from Microsoft’s CDN. This avoids buffering large files through the proxy and is significantly faster.

Python

1
import os
2
import requests
3

4
site_id = "<YOUR_SITE_ID>"      # call GET /v1.0/sites/root to get your site ID
5

6
filename = "report.pdf"
7

8
response = actions.request(
9
    connection_name='sharepoint',
10
    identifier='user_123',
11
    path=f"/v1.0/sites/{site_id}/drive/root:/{filename}",
12
    method="GET",
13
    query_params={},
14
)
15
meta = response.json()
16

17
# Step 2: Stream directly from Microsoft CDN using the pre-authenticated URL
18
# No auth headers needed — the URL is cryptographically signed and expires in ~1 hour
19
download_url = meta["@microsoft.graph.downloadUrl"]
20

21
with requests.get(download_url, stream=True) as r:
22
    r.raise_for_status()
23
    with open(filename, "wb") as f:
24
        for chunk in r.iter_content(chunk_size=8 * 1024 * 1024):  # 8 MB chunks
25
            f.write(chunk)
26

27
print(f"Downloaded: {filename} ({os.path.getsize(filename):,} bytes)")

Upload a file

Upload a file to SharePoint’s Shared Documents folder. Scalekit injects the OAuth token automatically — your app never handles credentials directly.

Python

1
import mimetypes
2

3
site_id = "<YOUR_SITE_ID>"      # call GET /v1.0/sites/root to get your site ID
4

5
filename = "report.pdf"
6
with open(filename, "rb") as f:
7
    file_bytes = f.read()
8

9
mime_type = mimetypes.guess_type(filename)[0] or "application/octet-stream"
10

11
response = actions.request(
12
    connection_name='sharepoint',
13
    identifier='user_123',
14
    path=f"/v1.0/sites/{site_id}/drive/root:/{filename}:/content",
15
    method="PUT",
16
    query_params={},
17
    form_data=file_bytes,
18
    headers={"Content-Type": mime_type},
19
)
20

21
meta = response.json()
22
print(f"Uploaded: {meta['name']} → {meta['webUrl']}")

Execute a tool

Node.js
Python

const result = await actions.executeTool({
  connector: 'sharepoint',
  identifier: 'user_123',
  toolName: 'sharepoint_list_sites',
  toolInput: {},
});
console.log(result);

result = actions.execute_tool(
    tool_input={},
    tool_name='sharepoint_list_sites',
    connection_name='sharepoint',
    identifier='user_123',
)
print(result)

Setup

Install the SDK

Set your credentials

Create the SharePoint connection

Set up auth redirects

Get your client credentials

Add credentials in Scalekit

Authorize a user and make your first call

Tools

Call it

Returns

Download SharePoint File

Inputs

Find User by Email

Inputs

Get SharePoint Content Type

Inputs

Get SharePoint Drive Item

Inputs

Get SharePoint List

Inputs

Get SharePoint List Item

Inputs

Get SharePoint Search Suggestions

Inputs

Get SharePoint Site

Inputs

Get SharePoint Site Page

Inputs

Get SharePoint Site Permission

Inputs

List SharePoint Content Types

Inputs

List SharePoint Drive Item Children

Inputs

List SharePoint Site Drives

Inputs

List SharePoint File Versions

Inputs

List Followed Sites

Inputs

List SharePoint List Fields

Inputs

List SharePoint List Items

Inputs

List SharePoint Lists

Inputs

List SharePoint Site Members

Inputs

List SharePoint Site Pages

Inputs

List SharePoint Site Permissions

Inputs

List SharePoint Sites

Inputs

Search SharePoint

Inputs

Add Member to SharePoint Group

Inputs

Add SharePoint Site Role Assignment

Inputs

Check In SharePoint File

Inputs

Check Out SharePoint File

Inputs

Copy SharePoint Drive Item

Inputs

Create SharePoint Folder

Inputs

Create SharePoint List

Inputs

Create SharePoint List Field

Inputs

Create SharePoint List Item

Inputs

Create SharePoint Site Page

Inputs

Create SharePoint Subsite

Inputs

Follow SharePoint Document