Skip to main content
SharePoint logo
  • Category: documents
  • Auth: OAUTH2, S2S_OAUTH2
  • Composio-managed OAuth available? Yes
  • Tools: 149
  • Triggers: 0
  • Slug: SHARE_POINT
  • Version: 20261103_00

Frequently Asked Questions

If a user’s SharePoint site URL is under /teams/<site> instead of /sites/<site>, do not tell them to pass only <site> in the SharePoint Subsite field. A bare subsite value is interpreted as /sites/<site> by the toolkit.Re-initiate or reconnect the SharePoint account and set SharePoint Subsite to the full server-relative path, for example /teams/<site>. For per-call overrides, pass site_name: "/teams/<site>".

Tools

Slug: SHARE_POINT_ADD_ATTACHMENT_TO_LIST_ITEMTool 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.

Input Parameters

integer
required
ID of the list item to which the file will be attached.
string
required
Name to assign to the attachment file in SharePoint.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
required
The display title of the SharePoint list containing the target item.
string
Optional raw text content to upload (UTF-8 encoded). Use when not passing file_content.
object
File to attach. Alternatively, omit this and provide either ‘content_text’ for UTF-8 text or ‘content_base64’ for arbitrary bytes.
string
Optional base64-encoded bytes to upload. Use for binary content when not passing file_content.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_ADD_DEFAULT_VIEW_FIELDAdd one existing field to a SharePoint list’s default view. This changes view membership but does not create or modify the field itself.

Input Parameters

string
required
Canonical GUID of the SharePoint list whose default view will be updated.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
required
Non-empty internal or display name of an existing field to add to the default view.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_ADD_ROLE_ASSIGNMENT_TO_DOCUMENT_BY_PATHAdd a SharePoint role assignment to a file or folder selected by server-relative path after role inheritance has been broken. This visibly changes who can access the document; obtain explicit human approval for the target path, principal_id, and role_definition_id before executing.

Input Parameters

string
required
Decoded or URL-encoded server-relative path to the target file or folder. The path must start with ’/’. A complete ‘/sites/’ or ‘/teams/’ path determines the owning web even when site_name is supplied; an explicit site_name must identify that web or an ancestor. Site-local paths use site_name or the connection’s saved site. ‘/personal/’ OneDrive paths are not supported.
string ("file" | "folder")
required
Whether item_path identifies a file or a folder.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
integer
required
Positive SharePoint ID of the user or group to grant access.
integer
required
Positive SharePoint role definition ID to assign.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_ADD_ROLE_ASSIGNMENT_TO_ITEMTool to add a role assignment to a list item. Use when granting specific permissions to a user or group after breaking inheritance if needed. This action is externally visible and permanently alters item permissions; obtain explicit human approval for the target item and role_definition_id before executing.

Input Parameters

integer
required
ID of the list item to which to add the role assignment.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
required
Title of the SharePoint list containing the target item. Must exactly match the list’s display name.
integer
required
ID of the user or group to grant permissions.
integer
required
ID of the permission level (role definition) to assign.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_ADD_ROLE_ASSIGNMENT_TO_LISTTool to add a role assignment to a SharePoint list. Requires the list to have broken role inheritance first via SHARE_POINT_BREAK_ROLE_INHERITANCE_ON_LIST; inheriting lists will reject unique role assignments. Use when granting permissions to a user or group on a specific list.

Input Parameters

string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
required
The title of the SharePoint list to grant permissions on.
integer
required
The ID of the user or group principal to which the role will be assigned. Must be a site-collection-registered ID; use the Id returned by SHARE_POINT_ENSURE_USER to avoid invalid-principal errors.
integer
required
The ID of the role definition to assign (e.g., 1073741827 for Contribute).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_BREAK_ROLE_INHERITANCE_ON_ITEMTool to break permission inheritance on a list item. Call this before adding new role assignments; adding assignments prior leaves the item still inheriting parent permissions, causing unexpected access behavior. Use when you need to uniquely set permissions on an item after copying or clearing parent assignments.

Input Parameters

integer
required
ID of the list item whose permissions inheritance will be broken
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
required
Title of the list containing the item Must be the exact display name as shown in SharePoint UI, not the URL segment or internal name.
boolean
Whether to clear unique permissions on any child scopes of the item
boolean
Whether to copy existing parent role assignments to the item before breaking inheritance

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_BREAK_ROLE_INHERITANCE_ON_LISTBreaks permission inheritance on a SharePoint list, allowing you to set unique permissions. When you break inheritance, you can choose to: - Copy parent permissions as a starting point (copy_role_assignments=true) - Start fresh with no inherited permissions (copy_role_assignments=false) - Clear unique permissions on child items to re-inherit from this list (clear_subscopes=true) Use this when you need to manage list-level permissions independently from the site. Must be called before SHARE_POINT_ADD_ROLE_ASSIGNMENT_TO_LIST, which fails on lists still inheriting from the parent site.

Input Parameters

string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
required
The title of the SharePoint list to break permission inheritance on.
boolean
required
Whether to reset unique permissions on child items (folders, documents) to inherit from this list. Set true to remove all item-level custom permissions and force inheritance from the list. Set false to preserve existing item-level unique permissions.
boolean
required
Whether to copy parent permissions when breaking inheritance. Set true to start with a copy of the parent site’s permissions (recommended for most cases). Set false to start with empty permissions where only the current user has access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_CHECK_IN_FILETool to check in a file. Use after uploading or editing a document and you’re ready to finalize changes.

Input Parameters

string
Check-in comment to describe this version of the file. Defaults to empty string if not provided.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
integer ("0" | "1" | "2")
Check-in type: 0=MinorCheckIn (draft/minor version), 1=MajorCheckIn (published/major version), 2=OverwriteCheckIn (overwrite current version without creating new version). Defaults to 1 (Major version).
string
required
Server-relative URL of the file to check in, including library and folders. E.g., ‘/Shared Documents/example.docx’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_CHECK_OUT_SITE_PAGECheck out a modern SharePoint page by its positive Site Pages list-item ID.

Input Parameters

integer
required
Positive Site Pages list-item ID of the modern SharePoint page to check out.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_CLEAR_DEFAULT_VIEW_FIELDSRemove every field from a SharePoint list’s default view without deleting the fields themselves. This is a destructive view-configuration operation; use it only when the entire current default-view layout should be cleared.

Input Parameters

string
required
Canonical GUID of the SharePoint list whose default view will be cleared.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_CONFIGURE_LIST_VIEWUpdate a SharePoint list view’s title, CAML query, row limit, or visible fields, then read back the resulting configuration. At least one mutation is required.

Input Parameters

string
New non-empty display title for the view.
string
required
Canonical GUID of the SharePoint list containing the view.
string
required
Canonical GUID of the SharePoint view to configure.
integer
Maximum number of rows displayed per page (1-2147483647).
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
array
Internal field names to add to the view’s visible fields.
string
New CAML query content for the view, without the outer View element. Pass an empty string to clear the current query.
array
Internal field names to remove from the view’s visible fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_COPY_DRIVE_ITEMStart an asynchronous copy of a drive item and return Microsoft’s monitor URL. A successful call means the copy was accepted, not completed; inspect the monitor outside this action until it reports completed or failed.

Input Parameters

string
Non-empty name to give the copied item.
string
required
ID of the source file or folder to copy.
string
required
ID of the drive containing the source item.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
boolean
For a folder, copy only its children. True cannot be combined with name.
string ("fail" | "replace" | "rename")
Behavior when the destination name exists: fail, replace, or rename. Replace applies only to files.
string
Exact SharePoint site root returned by Microsoft, used primarily for OneDrive for Business personal sites, for example ‘https://contoso-my.sharepoint.com/personal/alex_contoso_com’. Do not pass a page, library, _api URL, query, or fragment. Do not combine with site_name.
string
ID of the destination drive. Requires destination_parent_item_id; omit it when copying within the source drive.
string
ID of the destination parent folder, when changing parent.
boolean
Whether to copy all version history. Microsoft may ignore this option when name is also supplied.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_CREATE_CONTENT_TYPECreates a SharePoint site content type with a name and optional description, group, and ID for use with lists or libraries.

Input Parameters

object
Model for the content type ID value object.
string
required
The name of the content type to create.
string
The group category for the content type, e.g., ‘Custom Content Types’, ‘Document Content Types’.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
Description of the content type. Provides context about the purpose and usage of this content type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_CREATE_DRIVE_FOLDER_BY_PATHCreate a folder beneath a path-addressed parent in a SharePoint document-library drive.

Input Parameters

string
required
ID of the target document-library drive.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
required
Name of the folder to create.
string
required
Decoded relative path from the drive root to the existing parent folder, for example ‘Reports/2026’.
string ("fail" | "replace" | "rename")
Behavior when the folder name exists: fail, replace, or rename.
string
Exact SharePoint site root returned by Microsoft, used primarily for OneDrive for Business personal sites, for example ‘https://contoso-my.sharepoint.com/personal/alex_contoso_com’. Do not pass a page, library, _api URL, query, or fragment. Do not combine with site_name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_CREATE_LIST_FIELDTool to create a new field (column) in a SharePoint list. Use when you need to programmatically add a column after confirming the list GUID.

Input Parameters

string
required
Display name of the new list field.
boolean
Whether the field is required (non-nullable).
string
required
GUID of the SharePoint list where the new field will be created. Obtain via SHARE_POINT_SHAREPOINT_CREATE_LIST or SHARE_POINT_GET_LIST_BY_TITLE before calling this tool.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
required
Internal name of the field (no spaces).
integer
required
Numeric value from SP.FieldType enumeration specifying the type of the field. Common values: 1=Counter, 2=Text (single line), 3=Note (multiple lines), 6=Choice, 8=Boolean, 9=Number (decimal), 11=URL, 20=User.
boolean
Whether values in this field must be unique. When True, the field will automatically be marked as Indexed, which SharePoint requires for unique-value enforcement.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_CREATE_LIST_FIELD_FROM_XMLCreate a SharePoint list field from native Field XML and AddFieldOptions flags.

Input Parameters

integer
Bitwise AddFieldOptions value from 0 through 63. Use 0 for the default; combine these flags by addition: 1 adds the field to the default content type, 2 adds it to no content type, 4 adds it to all content types, 8 uses the XML name as an internal-name hint, 16 adds it to the default view, and 32 rejects a duplicate display name.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
required
Exact SharePoint list title.
string
required
Complete non-empty SharePoint Field XML definition.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_CREATE_LIST_ITEM_BY_IDTool to create a new item in a SharePoint list using the list’s GUID. Use when you have the list GUID rather than the list title.

Input Parameters

object
required
Dictionary mapping internal field names to their values for the new list item. Example: {‘Title’: ‘New Item’, ‘Description’: ‘Item details’}. At minimum, provide ‘Title’ field for most lists.
string
required
The unique identifier (GUID) of the SharePoint list where the item will be created. Format: ‘12345678-1234-1234-1234-123456789abc’
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
required
The ListItemEntityTypeFullName required for __metadata.type in the request body. Format: ‘SP.Data.{ListName}ListItem’ (e.g., ‘SP.Data.TasksListItem’ or ‘SP.Data.AbcListItem’). Use GET_LIST_ITEM_ENTITY_TYPE_FULL_NAME to retrieve this value if unknown.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_CREATE_LIST_ITEM_IN_FOLDERTool to create a list item in a specific folder within a SharePoint list. IMPORTANT: This action works ONLY with SharePoint lists (not document libraries). The folder_url can be either a server-relative URL (e.g., ‘/Lists/MyList’) or an absolute URL (e.g., ‘https://site.sharepoint.com/sites/sitename/Lists/MyList’). To create files in document libraries, use a different action like upload_file.

Input Parameters

array
required
List of field name/value pairs to set on the new item.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
required
URL of the target folder within the list where the item will be created. Accepts both server-relative URLs (e.g., ‘/Lists/MyList’) and absolute URLs (e.g., ‘https://site.sharepoint.com/sites/sitename/Lists/MyList’). For the list root folder, use ‘/Lists/<ListName>’ or the full absolute URL. For a subfolder within the list, append the subfolder path. You can obtain this URL from the list’s RootFolder.ServerRelativeUrl property. This parameter works with SharePoint lists only, NOT document libraries.
string
required
The title of the SharePoint list where the item will be created. Must be an existing list (not a document library).
string
Optional check-in comment if the item is checked out.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_CREATE_LIST_VIEWCreate a view in a SharePoint list selected by GUID or exact title. Optional view settings are sent only when provided.

Input Parameters

boolean
Whether the new view displays results in pages.
string
Optional CAML query fragment for the new view.
string
required
Non-empty display title for the new list view.
string
Canonical GUID of the SharePoint list. Provide exactly one of list_id or list_title.
integer
Optional maximum number of list items displayed on one page of the view.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
Exact display title of the SharePoint list. Provide exactly one of list_id or list_title.
array
Optional ordered list of SharePoint field internal names included in the new view.
boolean
Whether the new view is personal rather than public.
integer ("0" | "1" | "2048" | "8193" | "131072" | "524288" | "67108864")
Optional Microsoft SP.ViewType value: 0=None, 1=Html, 2048=Grid, 8193=Recurrence, 131072=Chart, 524288=Calendar, or 67108864=Gantt.
boolean
Whether the new view becomes the list’s default view.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_CREATE_NAVIGATION_CHILDCreate a child link beneath an existing SharePoint navigation node.

Input Parameters

string
required
Non-empty site-relative or external destination URL.
string
required
Non-empty visible title for the child navigation link.
integer
required
Positive ID of the parent SharePoint navigation node.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
boolean
Whether the destination URL points outside SharePoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_CREATE_QUICK_LAUNCH_NODEAdd a navigation link to the selected SharePoint site’s Quick Launch collection.

Input Parameters

string
required
URL stored on the navigation node. It may be site-relative or absolute.
string
required
Anchor text displayed for the new Quick Launch link.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
boolean
Whether the URL may point outside the current SharePoint site collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_CREATE_SITE_COLLECTIONStart provisioning a modern communication or non-group team site collection and return its initial provisioning status; status 1 is not yet ready.

Input Parameters

string
required
Absolute URL for the new site collection on the connected SharePoint tenant, under /sites/ or /teams/.
integer
Locale identifier for the new site, such as 1033 for English.
string
Optional owner login or email. This is required by SharePoint when the connection uses app-only authentication.
string
required
Display title for the new site collection.
string
Optional description for the new site collection.
string ("SITEPAGEPUBLISHING#0" | "STS#3")
required
SITEPAGEPUBLISHING#0 creates a communication site; STS#3 creates a non-group-associated team site.
string
Optional visible classification value for the new site.
string
Optional GUID of a built-in SharePoint site design. When using a custom web_template_extension_id, omit this field; the required all-zero SiteDesignId is sent automatically.
string
Optional GUID of the sensitivity label to apply.
boolean
Whether sharing invitations can be sent by email for this site.
string
Optional GUID of a custom site design extension. SharePoint also requires an all-zero SiteDesignId, which this action sends automatically.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_CREATE_SITE_FIELDCreate a reusable web-level SharePoint field (site column) in the selected site. Use the returned field GUID and internal name when attaching or updating the site column.

Input Parameters

string
required
Non-empty display title of the reusable site field.
boolean
Whether list items must provide a value for this field.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string ("text" | "note" | "choice" | "boolean" | "number" | "url" | "user")
required
Supported SharePoint field type. Choose text, note, choice, boolean, number, url, or user.
string
Optional description shown for the site field.
string
Optional stable internal name. Omit it to let SharePoint derive the internal name from title. When provided, use at most 32 ASCII letters, digits, or underscores, beginning with a letter or underscore.
boolean
Whether values must be unique. Setting this to true automatically enables the SharePoint index required for uniqueness.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_CREATE_SITE_FIELD_FROM_XMLCreate a reusable site-scoped SharePoint field from complete field schema XML.

Input Parameters

integer
Bitwise combination of SP.AddFieldOptions values: 1 adds to the default content type, 2 adds to no content type, 4 adds to all content types, 8 uses the schema name as an internal-name hint, 16 adds to the default view, and 32 checks the display name. Use 0 for the default behavior.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
required
Complete non-empty SharePoint Field schema XML.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_CREATE_SITE_PAGECreate an unpublished Article-layout modern SharePoint site page draft.

Input Parameters

string
required
Non-empty title for the draft modern SharePoint site page.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
Advanced provider-native CanvasContent1 JSON array string. Use ’[]’ to create a blank page. For non-empty content, reuse CanvasContent1 obtained from an existing native SharePoint page rather than fabricating elements.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_CREATE_UPLOAD_SESSIONCreate a resumable upload session for a new file and return its preauthenticated upload URL.

Input Parameters

string
required
ID of the destination drive.
string
Optional If-Match ETag precondition for the destination item.
string
required
Relative path for the new file beneath the selected parent item or drive root, for example ‘Reports/annual report.pdf’.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
boolean
Whether the final upload fragment must be committed separately. Omit to use Microsoft’s default behavior.
string
Optional If-None-Match ETag precondition for the destination item.
string
ID of the destination parent folder. Omit to address item_path from the drive root.
string ("fail" | "replace" | "rename")
Behavior when an item already exists at the destination: fail, replace, or rename.
string
Exact SharePoint site root returned by Microsoft, used primarily for OneDrive for Business personal sites, for example ‘https://contoso-my.sharepoint.com/personal/alex_contoso_com’. Do not pass a page, library, _api URL, query, or fragment. Do not combine with site_name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_CREATE_WEBTool to create a new SharePoint subsite under the current site. Use when you need to create a new subsite with specific settings for permissions, language, and template.

Input Parameters

string
required
The URL segment for the new subsite (e.g., ‘TestSubWeb’). This becomes part of the site URL path. Must contain only letters, numbers, hyphens, and underscores.
string
required
The display title for the new subsite.
integer
Language code for the subsite. Default is 1033 (English - United States). Examples: 1031 (German), 1033 (English), 1036 (French), 1040 (Italian), 1041 (Japanese), 1042 (Korean), 1043 (Dutch), 2052 (Chinese - Simplified), 3082 (Spanish).
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
A description of the new subsite (optional).
string
Web template to use for the subsite. Use ‘sts’ for modern team site homepage or ‘sts#0’ for classic team site. Other options include ‘blog’, ‘wiki’, etc.
boolean
If true, the subsite will have unique permissions separate from the parent site. If false, it inherits permissions from the parent site.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_DELETE_DRIVE_ITEMMove a drive item selected by drive and item IDs to the SharePoint recycle bin.

Input Parameters

array
Optional conditions to bypass when deleting the item. Select bypass-shared-lock, bypass-checked-out, or both.
string
required
ID of the drive item to delete.
string
required
ID of the drive containing the item.
string
Optional ETag precondition. The item is deleted only when its current ETag matches this value; use ’*’ to match any current version.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
Exact SharePoint site root returned by Microsoft, used primarily for OneDrive for Business personal sites, for example ‘https://contoso-my.sharepoint.com/personal/alex_contoso_com’. Do not pass a page, library, _api URL, query, or fragment. Do not combine with site_name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_DELETE_DRIVE_ITEM_VERSION_CONTENTTool to delete content for a specific version of a drive item in SharePoint. Use when you need to remove the binary content associated with a particular version of a file while keeping the version metadata.

Input Parameters

string
required
The unique identifier of the drive. This is the ID of the document library or drive where the item is stored. You can get this from drive listing endpoints.
string
required
The unique identifier of the drive item (file or folder). This is the ID of the specific item whose version content you want to delete.
string
required
The unique identifier of the version. Version IDs are typically numeric strings like ‘1.0’, ‘2.0’, ‘24.0’, etc. You can retrieve version IDs by listing versions for a drive item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_DELETE_FILE_ITEMDelete a SharePoint document library file by server-relative path. An optional ETag controls conditional deletion; the default wildcard deletes regardless of version.

Input Parameters

string
ETag for conditional deletion. Use ’*’ (default) to delete regardless of version. Provide a specific ETag value to delete only if the file hasn’t been modified since that version.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
required
The server-relative path of the file to delete. This is the full path from the site root, including the document library and any parent folders. Format: ‘/DocumentLibrary/ParentFolder/FileName.ext’. Examples: ‘/Shared Documents/report.pdf’, ‘/Documents/2024/Q1/summary.docx’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_DELETE_FOLDERDeletes a SharePoint document library folder by its server-relative path. An ETag can be supplied for conditional deletion.

Input Parameters

string
ETag for conditional deletion. Use ’*’ (default) to delete regardless of version. Provide a specific ETag value to delete only if the folder hasn’t been modified since that version.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
required
The server-relative path of the folder to delete. This is the full path from the site root, including the document library and any parent folders. Format: ‘/DocumentLibrary/ParentFolder/FolderName’. Examples: ‘/Shared Documents/Reports’, ‘/Documents/2024/Q1’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_DELETE_LISTTool to delete a SharePoint list. Use when you need to remove a list by its GUID after confirming the correct list identifier.

Input Parameters

string
ETag for concurrency control; use ’*’ to delete regardless of version.
string
required
The GUID of the SharePoint list to delete (format: ‘xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx’).
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_DELETE_LIST_BY_TITLETool 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.

Input Parameters

string
ETag for concurrency control. Use ’*’ to force delete regardless of version, or provide a specific ETag value for version checking.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
required
The title of the SharePoint list to delete. This is a destructive operation that permanently removes the list and all its contents.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_DELETE_LIST_FIELDDelete one field, identified by canonical field GUID, from an explicitly selected SharePoint list. This permanently changes that list’s schema.

Input Parameters

string
IF-MATCH value for conditional deletion. The default ’*’ deletes the field regardless of its current version.
string
required
Canonical GUID of the SharePoint list containing the field.
string
required
Canonical GUID of the SharePoint field to delete.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_DELETE_LIST_ITEMTool to delete a SharePoint list item. Use when you need to permanently remove an item by its ID. Use after obtaining the item’s ETag to ensure concurrency control.

Input Parameters

integer
required
Numeric ID of the list item to delete
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
required
The exact title of the SharePoint list containing the item to delete
string
ETag value for concurrency control. Use ’*’ to force delete regardless of version. If providing a specific ETag, use the full quoted value returned by GET_LIST_ITEM_ETAG (e.g., ‘“guid,version”’ format like ‘“c7a93369-bda8-4da1-b1a3-3d87d2e207fc,1”’). Simple version numbers like ‘1’ are not valid ETags.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_DELETE_LIST_ITEMSTool to delete multiple SharePoint list items in bulk. Use when you need to permanently remove multiple items by their IDs. This action is irreversible - deleted items cannot be recovered. For recoverable deletion, use the recycle action instead. Use this action when you have a list of item IDs to delete from the same list.

Input Parameters

array
required
List of numeric IDs of the list items to delete. All items must exist in the specified list.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
required
The exact title of the SharePoint list containing the items to delete
string
ETag value for concurrency control. Use ’*’ to force delete regardless of version for all items. If providing a specific ETag, all items will use the same ETag constraint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_DELETE_RECYCLE_BIN_ITEM_PERMANENTTool to permanently delete a SharePoint Recycle Bin item. Use after confirming the item’s GUID to remove it irrevocably.

Input Parameters

string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
required
GUID of the Recycle Bin item to delete permanently. Must not be empty. Retrieve this GUID by querying the recycle bin and cross-referencing item name, original path, and deletion timestamp to confirm the correct item before deletion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_DOWNLOAD_FILE_BY_SERVER_RELATIVE_URLTool 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.

Input Parameters

string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used. A complete ‘/sites/’ or ‘/teams/’ resource path determines the owning web even when site_name is supplied. An explicit site_name must identify that web or an ancestor; unrelated selectors return an error. Site-local paths use site_name or the connection’s saved site.
string
required
Server-relative URL of the file to download, starting with ’/’. Can be either URL-encoded or unencoded. E.g., ‘/Shared Documents/report.pdf’ for root site, ‘/sites/CustomerDocs/archive/Shared Documents/file.pdf’ for a nested subsite, or ‘/personal/username_domain/Documents/file.docx’ for personal OneDrive sites. A complete ‘/sites/’ or ‘/teams/’ resource path determines the owning web even when site_name is supplied. An explicit site_name must identify that web or an ancestor; unrelated selectors return an error. Site-local paths use site_name or the connection’s saved site.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_ENSURE_USEREnsure a user exists in a SharePoint site using a login name or email, returning their user information. This write operation may register the user and optionally update their display name, but does not assign permissions.

Input Parameters

string
Email address of the user to add to SharePoint. Automatically converted to claims format ‘i:0#.f|membership|{email}’. Either email or login_name must be provided.
string
Optional display name/title for the user in SharePoint. If provided, the user’s title will be updated after ensuring them.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
Login name of the user in SharePoint claims format (e.g., ‘i:0#.f|membership|user@domain.com’). Either login_name or email must be provided. If both are given, login_name takes priority. Throws an exception if login_name does not map to a real directory user; in batch operations, handle each user individually to prevent one failure from halting the batch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_FOLLOWFollow a SharePoint user, document, site, or tag. Use to make the authenticated user follow a specified actor. Supports following users (actor_type=0), documents (actor_type=1), sites (actor_type=2), or tags (actor_type=3).

Input Parameters

string
GUID of the tag when actor_type=3.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
integer ("0" | "1" | "2" | "3")
required
Type of the actor to follow: 0=user, 1=document, 2=site, 3=tag.
string
URI of the document or site when actor_type=1 or 2, e.g., ‘http://server/site’.
string
Account name for a user when actor_type=0, in claims format, e.g., ‘i:0#.f|membership|user@domain.com’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_GET_ALL_FOLDERSRetrieves folders from a SharePoint web for site discovery. Supports OData filtering, field selection, expansion, sorting, and a result limit; the response does not expose a continuation token.

Input Parameters

integer
OData $top to limit the number of folders returned.
string
OData $expand to include related entities such as ‘Files,Folders,ListItemAllFields’.
string
OData $filter to narrow results based on folder properties.
string
OData $select to specify which folder fields to return (comma-separated), e.g., ‘Name,ServerRelativeUrl,ItemCount’.
string
The SharePoint tenant name (e.g., ‘composio2024’ for composio2024.sharepoint.com). This parameter is not used; tenant information is derived from the authenticated connection.
string
OData $orderby to sort results, e.g., ‘Name asc’ or ‘TimeCreated desc’.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_GET_CHANGESTool to retrieve changes from SharePoint list change log. Use when processing webhook notifications to get actual changes that occurred. Set boolean flags in query (Add, Item, Update, etc.) to filter change types. Store the ChangeToken from the last change and use as ChangeTokenStart in subsequent calls to track only new changes.

Input Parameters

object
required
Change query parameters specifying which types of changes to retrieve. Set boolean properties to True to include specific change types (e.g., Add=True, Item=True for new items).
string
required
GUID of the SharePoint list to get changes for, in canonical format, e.g., ‘a12e3d6e-9414-462d-bd53-cf06f3982ad3’.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_GET_CONTENT_TYPERetrieves a SharePoint site content type by ID, including its metadata and available form properties.

Input Parameters

string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
required
The unique identifier of the content type to retrieve. This can be the hexadecimal content type ID (e.g., ‘0x01’ for Item, ‘0x0101’ for Document) or the string representation. Common IDs: ‘0x01’ (Item), ‘0x0101’ (Document), ‘0x0120’ (Folder).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_GET_CONTENT_TYPESRetrieves all content types from the current SharePoint site. Use this action to discover available content types on a SharePoint site. Returns metadata for each content type including Id, Name, Description, Group, and other properties. Supports OData query parameters for filtering, selecting specific fields, sorting, and pagination.

Input Parameters

integer
Maximum number of results to return. For pagination, combine with skip and increase skip by top until a page contains fewer than top results.
integer
Zero-based number of results to skip. SharePoint does not return a continuation token for this collection; use 0 for the first page, then increase by top for each subsequent page.
string
OData $expand to include related entities.
string
OData $filter to narrow results, e.g., ‘Hidden eq false’.
string
OData $select to specify which content type fields to return, e.g., ‘Name,Id,Description’.
string
OData $orderby to sort results, e.g., ‘Name asc’.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
Deprecated compatibility input for callers that already supply a raw OData $skiptoken. SharePoint does not return a skiptoken for this collection; use numeric skip instead. Ignored when skip is provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_GET_CONTENT_TYPES_FOR_LISTTool to retrieve all content types for a specific SharePoint list by GUID. Use when you need the content type IDs, names, and descriptions of every content type in a list.

Input Parameters

string
required
GUID of the SharePoint list to retrieve content types for, in canonical format, e.g., ‘01234567-89ab-cdef-0123-456789abcdef’.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_GET_CONTEXT_INFOTool to retrieve SharePoint context information including the form digest value. Use when you need a form digest token for write operations (POST, PUT, DELETE).

Input Parameters

string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_GET_CURRENT_USERTool to retrieve the current user for the site. Use after authenticating to get the current SharePoint user. A successful response confirms authentication only; access to specific sites, lists, or libraries depends on separate scopes and item-level permissions.

Input Parameters

string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_GET_CURRENT_USER_DRIVEResolve and return the connected user’s default OneDrive using delegated authentication.

Input Parameters

string
Comma-separated drive properties to return. Allowed values are id, name, driveType, webUrl, createdDateTime, lastModifiedDateTime, description, owner, quota, root, sharepointIds, and system. When a projection is provided, id is always included. Omit this field for the full drive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_GET_DEFAULT_DRIVE_ROOTGet the root drive item of a SharePoint site’s default document library.

Input Parameters

string
Comma-separated relationships to expand. Allowed values are children, listItem, thumbnails, and versions.
string
Comma-separated drive-item properties to return.
string
required
ID of the SharePoint site whose default document-library root to retrieve. Use ‘root’ for the selected site’s root site.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
Exact SharePoint site root returned by Microsoft, used primarily for OneDrive for Business personal sites, for example ‘https://contoso-my.sharepoint.com/personal/alex_contoso_com’. Do not pass a page, library, _api URL, query, or fragment. Do not combine with site_name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_GET_DRIVE_BY_IDGet one SharePoint or OneDrive drive by its drive ID from the selected site endpoint.

Input Parameters

string
Comma-separated drive properties to return. Allowed values are id, name, driveType, webUrl, createdDateTime, lastModifiedDateTime, description, owner, quota, root, sharepointIds, and system.
string
required
Unique ID of the drive to retrieve.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
Exact SharePoint site root returned by Microsoft, used primarily for OneDrive for Business personal sites, for example ‘https://contoso-my.sharepoint.com/personal/alex_contoso_com’. Do not pass a page, library, _api URL, query, or fragment. Do not combine with site_name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_GET_DRIVE_ITEM_ANALYTICSTool to get analytics for a SharePoint drive item. Use when you need to retrieve access statistics (view counts, unique viewers) for files or folders in SharePoint/OneDrive.

Input Parameters

string
required
The unique identifier of the drive containing the item.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string ("allTime" | "lastSevenDays")
Time range for analytics data. Use ‘allTime’ for all-time statistics or ‘lastSevenDays’ for the last seven days.
string
required
The unique identifier of the drive item to get analytics for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_GET_DRIVE_ITEM_BY_IDGet metadata for one file or folder by drive ID and item ID from a SharePoint site or provider-derived OneDrive for Business personal-site URL.

Input Parameters

string
Comma-separated relationships to expand. Allowed values are children, listItem, thumbnails, and versions.
string
Comma-separated drive-item properties to return. Supported core values include id, name, size, webUrl, timestamps, identities, parentReference, file, folder, fileSystemInfo, eTag, cTag, sharepointIds, and listItem.
string
required
ID of the file or folder to retrieve.
string
required
ID of the drive containing the item.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
Exact SharePoint site root returned by Microsoft, used primarily for OneDrive for Business personal sites, for example ‘https://contoso-my.sharepoint.com/personal/alex_contoso_com’. Do not pass a page, library, _api URL, query, or fragment. Do not combine with site_name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_GET_DRIVE_ITEM_BY_PATHGet a file or folder from a site’s default document library by its drive-root-relative path.

Input Parameters

string
Comma-separated relationships to expand. Allowed values are children, listItem, thumbnails, and versions.
string
Comma-separated drive-item properties to return. Supported core values include id, name, size, webUrl, timestamps, identities, parentReference, file, folder, fileSystemInfo, eTag, cTag, sharepointIds, and listItem.
string
required
Path of the file or folder relative to the default document library’s root, for example ‘Reports/Quarterly report.pdf’. Do not include a leading slash or relative path segments.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
Exact SharePoint site root returned by Microsoft, used primarily for OneDrive for Business personal sites, for example ‘https://contoso-my.sharepoint.com/personal/alex_contoso_com’. Do not pass a page, library, _api URL, query, or fragment. Do not combine with site_name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_GET_DRIVE_ITEM_CHANGESReturn one page of drive-item changes and the opaque next or delta link. Use token=‘latest’ to obtain a checkpoint without enumerating existing items, then pass a returned continuation URL back unchanged.

Input Parameters

integer
Maximum number of changes requested for this page.
string
Provider delta token for an initial fixed-route call. Use ‘latest’ to get a checkpoint without enumerating existing items.
string
Comma-separated drive-item relationship identifiers to expand.
string
Comma-separated drive-item property identifiers to return.
string
required
ID of the drive whose changes to retrieve.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
Opaque next, delta, or resync URL previously returned by this action. Pass it back unchanged and do not combine it with token or OData options.
string
Exact SharePoint site root returned by Microsoft, used primarily for OneDrive for Business personal sites, for example ‘https://contoso-my.sharepoint.com/personal/alex_contoso_com’. Do not pass a page, library, _api URL, query, or fragment. Do not combine with site_name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_GET_DRIVE_ITEM_THUMBNAILS_BY_PATHRetrieve thumbnail URL and dimension sets for a default-drive item by path.

Input Parameters

string
Comma-separated standard or custom thumbnail size names, for example ‘small,medium’ or ‘c300x400_crop’.
string
required
Path to the file or folder relative to the default drive root, for example ‘Photos/image.jpg’.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
Exact SharePoint site root returned by Microsoft, used primarily for OneDrive for Business personal sites, for example ‘https://contoso-my.sharepoint.com/personal/alex_contoso_com’. Do not pass a page, library, _api URL, query, or fragment. Do not combine with site_name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_GET_FILE_BY_SERVER_RELATIVE_URLFetch SharePoint file metadata by server-relative path using the ServerRelativePath API, without downloading file content. This deprecated action returns an existence flag and available file properties such as URL and unique ID.

Input Parameters

string
OData $expand query option. Comma-separated list of related entities to expand, such as ‘ListItemAllFields’ to include list item metadata.
string
OData $select query option. Comma-separated list of fields to return. E.g., ‘ServerRelativeUrl,UniqueId,Name,Length,TimeLastModified,LinkingUri’.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used. If omitted and the file path starts with ‘/sites/{site}/’, the site is inferred from the path; nested subsites still require their complete web path.
string
required
Decoded server-relative path of the file, starting with ’/’. E.g., ‘/sites/Finance/Shared Documents/W-9.pdf’ or ‘/Shared Documents/report.pdf’. Do not URL-encode; provide the path with spaces and special characters as-is.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_GET_FOLDER_BY_SERVER_RELATIVE_URLDeprecated: retrieves SharePoint folder metadata by server-relative URL. Expanded immediate subfolders are returned in the Folders array and can be retrieved individually to traverse nested structures.

Input Parameters

string
OData $expand query option. Comma-separated list of related entities to expand, such as ‘Files,Folders,ListItemAllFields’. Expanding Files or Folders can produce large responses; access nested data via Files.results and Folders.results arrays.
string
OData $select query option. Comma-separated list of fields to return. E.g., ‘Name,ServerRelativeUrl,ItemCount’.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
required
Server-relative URL of the folder to retrieve, including library and any parent folders. Can be provided as a plain path (e.g., ‘/Shared Documents/MyFolder’) or as a pre-encoded URL (e.g., ‘/Shared%20Documents/MyFolder’). Both formats are accepted and handled correctly. Path must exactly match the real SharePoint library name (e.g., ‘/Shared Documents’ not ‘/Documents’); extra or missing slashes cause resolution failures. Prefer reusing the server_relative_url returned by this tool for downstream calls rather than constructing paths manually.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_GET_GROUP_USERSLists users in a SharePoint group by name, returning a page of user information. Supports OData filtering, sorting, field selection, and pagination using top and skip.

Input Parameters

integer
Maximum number of users to return. For pagination, combine with skip and increase skip by top until a page contains fewer than top users.
integer
Zero-based number of users to skip. SharePoint does not return a continuation token for this collection; use 0 for the first page, then increase by top for each subsequent page.
string
OData $expand parameter to expand related navigation properties. Use ‘Groups’ to get the user’s group memberships.
string
OData $filter parameter to filter the returned users. Use OData filter syntax (e.g., ‘PrincipalType eq 1’ for regular users).
string
OData $select parameter to return only specific user fields. Comma-separated field names (e.g., ‘Id,Title,Email,LoginName’).
string
OData $orderby parameter to sort the returned users. Specify field name and optional ‘asc’ or ‘desc’ (e.g., ‘Title desc’).
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
Deprecated compatibility input for callers that already supply a raw OData $skiptoken. SharePoint does not return a skiptoken for this collection; use numeric skip instead. Ignored when skip is provided.
string
required
Name of the SharePoint group to retrieve users from. Use the LoginName or Title of the group (e.g., ‘Communication site Members’, ‘Site Owners’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_GET_GROUP_USERS_BY_IDLists users in a SharePoint site group by numeric group ID, returning a page of user information. Supports OData filtering, sorting, field selection, and pagination using top and skip.

Input Parameters

integer
Maximum number of users to return. For pagination, combine with skip and increase skip by top until a page contains fewer than top users.
integer
Zero-based number of users to skip. SharePoint does not return a continuation token for this collection; use 0 for the first page, then increase by top for each subsequent page.
string
OData $expand parameter to expand related navigation properties. Use ‘Groups’ to get the user’s group memberships.
string
OData $filter parameter to filter the returned users. Use OData filter syntax (e.g., ‘PrincipalType eq 1’ for regular users).
string
OData $select parameter to return only specific user fields. Comma-separated field names (e.g., ‘Id,Title,Email,LoginName’).
string
OData $orderby parameter to sort the returned users. Specify field name and optional ‘asc’ or ‘desc’ (e.g., ‘Title desc’).
integer
required
Numeric ID of the SharePoint site group to retrieve users from. Use list_site_groups action to get available group IDs.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
Deprecated compatibility input for callers that already supply a raw OData $skiptoken. SharePoint does not return a skiptoken for this collection; use numeric skip instead. Ignored when skip is provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_GET_ITEM_ATTACHMENT_CONTENTTool to download an attachment from a SharePoint list item. Use when retrieving the binary contents of a specific attachment after confirming the list title, item ID, and filename.

Input Parameters

integer
required
ID of the list item to retrieve the attachment from (must be non-negative).
string
required
Exact name of the attachment file, including extension.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
required
Title of the SharePoint list containing the target item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_GET_LIST_BY_GUIDTool to retrieve a SharePoint list by its GUID. Use when you need to fetch list metadata by its unique identifier. Prefer over name-based lookup tools when the GUID is known, as names may collide across similarly named lists.

Input Parameters

string
Comma-separated list of related entities to include in the response. Common values: Fields (list fields/columns), RootFolder (folder information), ContentTypes, Views. Example: ‘Fields’ or ‘RootFolder’
string
Comma-separated list of fields to return. Limits the response to only specified fields. Common fields: Title, Id, Description, ItemCount, BaseType, BaseTemplate, Created, Hidden, EntityTypeName, ListItemEntityTypeFullName. Example: ‘Title,Id,ItemCount’
string
required
GUID of the SharePoint list to retrieve, in canonical format, e.g., ‘01234567-89ab-cdef-0123-456789abcdef’.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_GET_LIST_BY_TITLETool to retrieve a SharePoint list by its title. Use when you need to fetch list metadata by title.

Input Parameters

string
Comma-separated list of related entities to include in the response. Common values: Fields (list fields/columns), RootFolder (folder information), ContentTypes, Views. Example: ‘Fields’ or ‘RootFolder’ Expanding Fields includes system and hidden fields; check the Hidden metadata flag to identify user-facing columns.
string
Comma-separated list of fields to return. Limits the response to only specified fields. Common fields: Title, Id, Description, ItemCount, BaseType, BaseTemplate, Created, Hidden, EntityTypeName, ListItemEntityTypeFullName. Example: ‘Title,Id,ItemCount’ Include ‘Id’ when the list GUID is needed as list_guid/list_id for downstream calls like SHARE_POINT_CREATE_LIST_FIELD.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
required
Title of the SharePoint list to retrieve. Will be URL-encoded and enclosed in single quotes in the endpoint. Must be an exact case-sensitive match to the list’s display title; typos or renamed lists will cause lookup failures.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_GET_LIST_CONTENT_TYPE_BY_IDRetrieves a SharePoint list content type by list ID and content type ID, returning its metadata and any schema or fields supplied in the response. Fields may be deferred rather than expanded.

Input Parameters

string
required
GUID of the SharePoint list containing the content type, in canonical format (e.g., ‘0e0f0c3b-e23e-4aaf-8e22-803a3b572315’).
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
required
The content type identifier, a hexadecimal string (e.g., ‘0x010100EAADC19ECD09234BAD136AAD68B38066’). This is the unique ID of the content type within SharePoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_GET_LIST_FIELDGet one field definition from a SharePoint list by field GUID or exact internal name/title.

Input Parameters

string
Comma-separated OData $expand expression for related field properties.
string
Comma-separated OData $select projection of field properties.
string
Canonical GUID of the SharePoint list. Provide exactly one of list_id or list_title.
string
Canonical GUID of the field. Provide exactly one of field_id or field_name.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
Case-sensitive field internal name or title. Provide exactly one of field_id or field_name.
string
Exact display title of the SharePoint list. Provide exactly one of list_id or list_title.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_GET_LIST_ITEM_BY_IDTool to retrieve a SharePoint list item by ID. Use when you need to fetch a specific item after knowing its ID.

Input Parameters

string
OData $expand to expand related entities, e.g., ‘Author,Editor’. Must be used together with select parameter that includes the expanded fields.
string
OData $select to specify which fields to return, e.g., ‘Title,Created’. Required when using expand parameter.
integer
required
Numeric ID of the list item to retrieve.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
required
Display title of the target SharePoint list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_GET_LIST_ITEMSTool to retrieve items from a SharePoint list. Use when you need to fetch list entries with optional OData parameters.

Input Parameters

integer
Maximum number of items to return.
string
Comma-separated list of navigation properties to expand for lookup fields. Some fields, including Author and Editor, require select to include the corresponding expanded subfields. For example, use expand=‘Author,Editor’ with select=‘Id,Author/Title,Editor/Title’.
string
OData filter expression to limit results (e.g., Title eq ‘Test’).
string
Comma-separated list of internal field names to return. Use '' to retrieve all available fields, which is recommended when you don’t know the exact field names. When expanding user fields such as Author or Editor, select must include the corresponding expanded subfields, for example, ‘Id,Author/Title,Editor/Title’ with expand=‘Author,Editor’. SharePoint uses internal field names, not display names - spaces are hex-encoded as ‘x0020’ (e.g., ‘File_x0020_Size’ for ‘File Size’). Common system fields: Id, Title, Created, Modified, AuthorId, EditorId, GUID, FileLeafRef (file name), FileDirRef (folder path), FileRef (server-relative URL). Field availability varies by list type: document libraries include file-specific fields like File_x0020_Size, while custom lists have their own schema. To discover available fields for a specific list, either: (1) use select='' first to see all fields returned in items, or (2) use SHARE_POINT_GET_LIST_BY_TITLE with expand=‘Fields’ to get field metadata including InternalName.
string
OData orderby expression to sort results (e.g., Created desc).
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
Pagination token returned as skiptoken by the previous response. Pass it unchanged to retrieve the next page.
string
required
Exact Title property value of the SharePoint list to query. The Title property value varies by site configuration and localization - for example, the default document library’s Title may be ‘Documents’, ‘Shared Documents’, or a localized name. To find the exact Title property value, use SHARE_POINT_LIST_ALL_LISTS which returns all lists with their Title properties.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_GET_LIST_ITEMS_BY_GUIDTool to retrieve items from a SharePoint list using its GUID. Use when you have the list’s unique identifier and need to fetch list entries with optional OData parameters.

Input Parameters

integer
Maximum number of items to return.
string
Comma-separated list of navigation properties to expand for lookup fields. Some fields, including Author and Editor, require select to include the corresponding expanded subfields. For example, use expand=‘Author,Editor’ with select=‘Id,Author/Title,Editor/Title’.
string
OData filter expression to limit results (e.g., Title eq ‘Test’).
string
Comma-separated list of internal field names to return. Use '' to retrieve all available fields, which is recommended when you don’t know the exact field names. When expanding user fields such as Author or Editor, select must include the corresponding expanded subfields, for example, ‘Id,Author/Title,Editor/Title’ with expand=‘Author,Editor’. SharePoint uses internal field names, not display names - spaces are hex-encoded as ‘x0020’ (e.g., ‘File_x0020_Size’ for ‘File Size’). Common system fields: Id, Title, Created, Modified, AuthorId, EditorId, GUID, FileLeafRef (file name), FileDirRef (folder path), FileRef (server-relative URL). Field availability varies by list type: document libraries include file-specific fields like File_x0020_Size, while custom lists have their own schema. To discover available fields for a specific list, either: (1) use select='' first to see all fields returned in items, or (2) use SHARE_POINT_GET_LIST_BY_GUID with expand=‘Fields’ to get field metadata including InternalName.
string
OData orderby expression to sort results (e.g., Created desc).
string
required
GUID of the SharePoint list to retrieve items from, in canonical format. The GUID uniquely identifies a list across the SharePoint site. To find list GUIDs, use SHARE_POINT_LIST_ALL_LISTS which returns all lists with their Id (GUID) properties.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
Pagination token returned as skiptoken by the previous response. Pass it unchanged to retrieve the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_GET_LIST_ITEM_VERSIONTool to retrieve a specific version of a SharePoint list item. Use when you need to access historical versions of list items.

Input Parameters

integer
required
Numeric ID of the list item whose version to retrieve.
string
required
GUID of the SharePoint list in canonical format, e.g., ‘01234567-89ab-cdef-0123-456789abcdef’.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
integer
required
Version ID of the specific list item version to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_GET_MY_FOLLOWEDTool to get entities the current user is following. Use when you need to retrieve followed users, documents, sites, or tags after authentication.

Input Parameters

integer
required
Bitmask of actor types to include. Users=1, Documents=2, Sites=4, Tags=8. Combine values with bitwise OR (e.g., 15 for all).
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_GET_MY_FOLLOWERSRetrieves the list of users who are following the authenticated user in SharePoint. Returns an array of SocialActor objects containing follower details like name, email, account name, and personal site URI. No parameters required - automatically retrieves followers for the current authenticated user.

Input Parameters

string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_GET_ROLE_DEFINITIONSTool 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 can modify role sets and IDs differ across site collections. Always resolve current values dynamically via this tool.

Input Parameters

integer
Maximum number of role definitions to return. For pagination, combine with skip and increase skip by top until a page contains fewer than top results.
integer
Zero-based number of role definitions to skip. SharePoint does not return a continuation token for this collection; use 0 for the first page, then increase by top for each subsequent page.
string
OData expand: Expand related entities (bulk expansion not supported).
string
OData filter: Expression to filter returned role definitions (e.g., “Name eq ‘Read’”). Name-based filters may be case-sensitive or locale-sensitive; normalize role names before constructing filter expressions to avoid empty results.
string
OData select: Comma-separated list of properties to return (e.g., ‘Name,Id’).
string
OData orderby: Sort order (e.g., ‘Name desc’).
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
Deprecated compatibility input for callers that already supply a raw OData $skiptoken. SharePoint does not return a skiptoken for this collection; use numeric skip instead. Ignored when skip is provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_GET_SHARESAccess a shared SharePoint file or folder by share ID or encoded sharing URL without granting lasting access.

Input Parameters

string
Comma-separated relationships to expand, such as driveItem for sharing metadata or children for a shared folder’s drive item.
string ("redeemSharingLinkIfNecessary")
Optional temporary sharing-link redemption behavior. ‘redeemSharingLinkIfNecessary’ grants access only as needed for this request and does not create a lasting permission.
string
Comma-separated properties to return, such as id,name,webUrl.
string ("shared_drive_item" | "drive_item")
Resource to return. ‘shared_drive_item’ returns sharing metadata; ‘drive_item’ returns the shared file or folder directly.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
Exact SharePoint site root returned by Microsoft, used primarily for OneDrive for Business personal sites, for example ‘https://contoso-my.sharepoint.com/personal/alex_contoso_com’. Do not pass a page, library, _api URL, query, or fragment. Do not combine with site_name.
string
required
Share ID returned by the sharing API, or a sharing URL encoded as unpadded base64url with the ‘u!’ prefix.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_GET_SITE_BY_HOSTNAMERetrieve SharePoint site information by hostname or URL. Returns site metadata including site ID, display name, URLs, and timestamps. Use this action when you need to discover a site’s identifier or properties using only its hostname, which is essential for subsequent operations requiring siteId. Useful for validating site existence or obtaining site metadata without prior knowledge of internal IDs.

Input Parameters

string
required
The fully qualified domain name of the SharePoint site to retrieve (e.g., ‘contoso.sharepoint.com’ or ‘contoso.sharepoint.com:/sites/teamsite’). Can include a server-relative path after a colon for subsites.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_GET_SITE_BY_IDRetrieve metadata for a SharePoint site web by its GUID within the selected site collection, such as its title, URL, language, or template information.

Input Parameters

string
OData $expand to expand navigation properties, e.g., ‘CurrentUser,Lists,Webs’.
string
OData $select to specify fields to return, e.g., ‘Id,Title,Url,ServerRelativeUrl’.
string
required
The unique identifier (GUID) of the SharePoint site to retrieve. This is the site’s web ID.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used. The site_id lookup is limited to the selected site collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_GET_SITE_COLLECTION_INFOFetch metadata for the selected SharePoint site collection, including its URL, ID, and root web information.

Input Parameters

string
OData $expand to expand navigation properties, e.g., ‘Owner,RootWeb’.
string
OData $select to specify fields to return, e.g., ‘Id,Url,ServerRelativeUrl’.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_GET_SITE_DRIVE_ITEM_BY_PATHTool to retrieve a file or folder by its server-relative path in a SharePoint site. Use when you need to get metadata for an item (file or folder) by path.

Input Parameters

string
OData $expand query option. Comma-separated list of related entities to expand. E.g., ‘ListItemAllFields’ for files, or ‘Files,Folders’ for folders.
string
OData $select query option. Comma-separated list of fields to return. E.g., ‘Name,ServerRelativeUrl,UniqueId,Length,TimeLastModified’.
string
required
Server-relative path of the file or folder to retrieve, starting with ’/’. E.g., ‘/Shared Documents/file.pdf’ for files or ‘/Shared Documents/MyFolder’ for folders. Can be provided as a plain path or pre-encoded. Both formats are accepted. A complete ‘/sites/’ or ‘/teams/’ resource path determines the owning web even when site_name is supplied. An explicit site_name must identify that web or an ancestor; unrelated selectors return an error. Site-local paths use site_name or the connection’s saved site.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used. A complete ‘/sites/’ or ‘/teams/’ resource path determines the owning web even when site_name is supplied. An explicit site_name must identify that web or an ancestor; unrelated selectors return an error. Site-local paths use site_name or the connection’s saved site.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_GET_SITE_FIELDRetrieve one web-scoped SharePoint field by its GUID. Use select to limit the returned field metadata to specific properties.

Input Parameters

string
Comma-separated OData $select projection, such as ‘Id,Title,InternalName,TypeAsString’.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
required
Canonical GUID of the web-scoped SharePoint field to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_GET_SITE_PAGE_CONTENTTool to retrieve modern SharePoint Site Pages content by reading list item fields. Use when a .aspx page result cannot be downloaded as a file or when you need the structured content (CanvasContent1, LayoutWebpartsContent) of modern pages.

Input Parameters

integer
List item ID of the page in the Site Pages library. Either page_file_name or item_id must be provided.
string ("raw" | "text" | "html")
Format for retrieving content fields. ‘raw’ returns direct field values (CanvasContent1, LayoutWebpartsContent). ‘text’ uses FieldValuesAsText endpoint for plain text rendering. ‘html’ uses FieldValuesAsHtml endpoint for HTML rendering.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
File name of the modern SharePoint page to retrieve (e.g., ‘Formed-LLC-&-Received-EIN.aspx’). Must include the .aspx extension. Either page_file_name or item_id must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_GET_SITE_ROOTRetrieves metadata about the root web of a SharePoint site collection. Use this action when you need to get information about the root site in a site collection, such as its title, URL, language settings, or template information. This is useful for discovering the top-level site properties before navigating to subsites or performing collection-wide operations.

Input Parameters

string
OData $expand parameter to expand navigation properties, e.g., ‘CurrentUser,Lists,Webs’.
string
OData $select parameter to specify which fields to return, e.g., ‘Id,Title,Url,ServerRelativeUrl’.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_GET_SITE_TIME_ZONEGet the regional time-zone definition for a selected SharePoint site.

Input Parameters

string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_GET_USER_EFFECTIVE_PERMISSIONS_ON_WEBGet a user’s effective permissions on the current SharePoint site (Web). This action retrieves the combined permissions a user has on the site, taking into account direct permissions, group memberships, and permission inheritance. Use this when you need to verify what permissions a user or group has before performing operations. The response contains permission masks as 64-bit integers split into high and low 32-bit values. A value of “0” for both means no permissions. Returns site-level permissions only; list-level or item-level grants and restrictions are not reflected.

Input Parameters

string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
required
Claims-based login name of the user or group whose permissions to retrieve. Provide the unencoded login; the action will URL-encode it automatically. Use list_site_users or get_current_user to obtain valid login names.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_GET_WEBHOOK_SUBSCRIPTIONTool to retrieve a specific webhook subscription by ID from a SharePoint list. Use when you need to check subscription details like expiration date or notification URL.

Input Parameters

string
required
GUID of the SharePoint list containing the subscription, in canonical format, e.g., ‘01234567-89ab-cdef-0123-456789abcdef’.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
required
GUID of the webhook subscription to retrieve, in canonical format, e.g., ‘01234567-89ab-cdef-0123-456789abcdef’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_GET_WEBHOOK_SUBSCRIPTIONSTool to retrieve all webhook subscriptions on a SharePoint list. Use when you need to view existing webhook configurations for a list.

Input Parameters

string
required
The GUID of the SharePoint list to retrieve subscriptions for, in canonical format (e.g., ‘01234567-89ab-cdef-0123-456789abcdef’).
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_GET_WEB_INFOTool to retrieve information about the current SharePoint web (site) using REST API. Use when you need web metadata such as title, URL, language, or template information.

Input Parameters

string
OData $expand to expand navigation properties, e.g., ‘CurrentUser,Lists,Webs’.
string
OData $select to specify fields to return, e.g., ‘Id,Title,Url,ServerRelativeUrl’.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_IS_FOLLOWEDTool to check if the current user is following a specified actor. Use when verifying follow status before performing follow or unfollow operations.

Input Parameters

string
GUID of the tag when actor_type=3.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
integer ("0" | "1" | "2" | "3")
required
Type of the actor to check: 0=user, 1=document, 2=site, 3=tag.
string
URI of the document or site when actor_type=1 or 2, e.g., ‘http://server/site’.
string
Account name for a user when actor_type=0, in claims format, e.g., ‘i:0#.f|membership|user@domain.com’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_LIST_ALL_LISTSRetrieves all lists in the current SharePoint web/site. Use this action to discover available lists and document libraries on a SharePoint site, or to pre-check for existing lists before creation (duplicate list names will fail). Returns metadata for each list including Title, Id, BaseType, ItemCount, and other properties. Supports OData query parameters for filtering, selecting specific fields, sorting, and pagination.

Input Parameters

integer
Maximum number of lists to return. For pagination, combine with skip and increase skip by top until a page contains fewer than top lists.
integer
Zero-based number of lists to skip. SharePoint does not return a continuation token for this collection; use 0 for the first page, then increase by top for each subsequent page.
string
OData $expand to include related entities.
string
OData $filter to narrow results.
string
OData $select to specify which list fields to return, e.g., ‘Title,Id’.
string
OData $orderby to sort results, e.g., ‘Title desc’.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
Deprecated compatibility input for callers that already supply a raw OData $skiptoken. SharePoint does not return a skiptoken for this collection; use numeric skip instead. Ignored when skip is provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_LIST_DEFAULT_VIEW_FIELDSList the field internal names currently displayed in a SharePoint list’s default view. Use this before adding or clearing default-view fields, and use SHARE_POINT_LIST_LIST_COLUMNS when full field definitions are needed.

Input Parameters

string
required
Canonical GUID of the SharePoint list whose default view fields to list.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_LIST_DRIVE_CHILDRENList a page of files and folders in a SharePoint drive’s root or a specified folder using REST API v2.0. The response may include a next-page link.

Input Parameters

integer
Number of items to return (OData $top parameter). Default is 200.
string
Comma-separated properties to return (e.g., ‘id,name,size,folder,file,webUrl’).
string
OData orderby expression (e.g., ‘name asc’, ‘lastModifiedDateTime desc’).
string
required
The unique identifier of the drive. This is the drive ID (GUID) that identifies a specific document library or OneDrive.
string
The unique identifier of a specific folder within the drive. If not provided, lists root folder children.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_LIST_DRIVE_ITEM_PERMISSIONSList effective sharing permissions for one drive item. This returns drive-item sharing/link permissions, not SharePoint web role assignments; non-owners may receive only permissions that apply to them.

Input Parameters

string
Comma-separated permission properties to return. Allowed values are id, roles, grantedToV2, grantedToIdentitiesV2, link, invitation, inheritedFrom, expirationDateTime, hasPassword, and shareId.
string
required
ID of the drive item whose permissions to list.
string
required
ID of the drive containing the item.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
Opaque next URL previously returned by this action. Pass it back unchanged and do not combine it with select.
string
Exact SharePoint site root returned by Microsoft, used primarily for OneDrive for Business personal sites, for example ‘https://contoso-my.sharepoint.com/personal/alex_contoso_com’. Do not pass a page, library, _api URL, query, or fragment. Do not combine with site_name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_LIST_DRIVE_ITEM_VERSIONSList retained versions of a SharePoint drive item, newest first.

Input Parameters

string
required
ID of the drive item whose versions to list.
string
required
ID of the drive containing the item.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
Opaque next URL previously returned by this action. Pass it back unchanged.
string
Exact SharePoint site root returned by Microsoft, used primarily for OneDrive for Business personal sites, for example ‘https://contoso-my.sharepoint.com/personal/alex_contoso_com’. Do not pass a page, library, _api URL, query, or fragment. Do not combine with site_name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_LIST_DRIVE_RECENT_ITEMSList recently modified files and folders in a SharePoint drive’s root, ordered by modification time. By default, collects up to the requested limit across pages; optional pagination returns one page and a continuation token.

Input Parameters

string
required
The unique identifier of the drive. This is the drive ID (GUID) that identifies a specific document library or OneDrive.
boolean
Set to true to return one provider page and an opaque continuation_token. Omit or set to false to preserve the legacy behavior of collecting up to row_limit items across provider pages.
integer
Maximum number of recently modified items to return. Default is 20.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
Opaque token returned by a previous paginated call. Pass it back unchanged with paginate=true and the same drive_id, site_name, and row_limit.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_LIST_DRIVES_REST_APITool 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 SharePoint authentication (not Microsoft Graph).

Input Parameters

integer
OData $top parameter - number of drives to return. Default: 100.
string
OData $expand parameter to expand related entities (e.g., ‘root,items’).
string
OData $select parameter - comma-separated properties to return (e.g., ‘id,name,webUrl,driveType’).
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
SharePoint REST v2 site identifier. Use ‘root’ for the site selected by site_name, or pass the opaque composite site ID returned by SHARE_POINT_GET_SITE_BY_HOSTNAME. Do not pass a site name or path here; use site_name for ‘/sites/…’ or ‘/teams/…’ paths.
string
Full same-origin SharePoint site or nested-subsite URL, for example ‘https://contoso.sharepoint.com/sites/marketing/archive’. It must identify a web root, not a page, library, list, or folder. If site_name is also provided, site_name wins. If omitted, the connection’s default site is used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_LIST_FILES_IN_FOLDERList files directly within a SharePoint folder by server-relative path, without recursively enumerating subfolders. Results can be paginated using top and skip; the response does not include a continuation token.

Input Parameters

integer
Maximum number of files to return. For pagination, combine with skip and increase skip by top until a page contains fewer than top files.
integer
Zero-based number of files to skip. SharePoint does not return a continuation token for this collection; use 0 for the first page, then increase by top for each subsequent page.
string
OData $expand to inline related entities (e.g., ‘ListItemAllFields’). When expanding ‘Files,Folders’, access results via Files.results and Folders.results arrays in the response.
string
OData $select to specify which file properties to return (comma-separated).
string
OData $orderby to sort the results (e.g., ‘Name desc’).
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
Deprecated compatibility input for callers that already supply a raw OData $skiptoken. SharePoint does not return a skiptoken for this collection; use numeric skip instead. Ignored when skip is provided.
string
required
Server-relative path of an existing folder. Use a site-local path such as ‘/Shared Documents/General’ or a full site path such as ‘/sites/MySite/Shared Documents/General’. SharePoint path matching is case-insensitive. A nonexistent folder returns an error.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_LIST_ITEM_ATTACHMENTSTool to list all attachments for a SharePoint list item. Use when you need to retrieve filenames and server-relative URLs of each attachment after confirming the list title and item ID.

Input Parameters

integer
required
ID of the list item to list attachments for (must be ≥ 1).
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
required
Display title of the SharePoint list containing the item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_LIST_LIST_COLUMNSList column definitions for a SharePoint list. First use SHARE_POINT_LIST_ALL_LISTS on the target site to obtain the list Id, then call this action with that list_id and the same site_name. Returns field metadata including column names, types, and properties.

Input Parameters

integer
OData $top to limit the number of results.
string
OData $filter to narrow results, e.g., ‘Hidden eq false’.
string
OData $select to specify which column fields to return, e.g., ‘Title,InternalName,TypeAsString’.
string
required
Required GUID of the SharePoint list to retrieve columns for, in canonical format, e.g., ‘01234567-89ab-cdef-0123-456789abcdef’. Use SHARE_POINT_LIST_ALL_LISTS to discover this Id, and pass the same site_name to both actions because SharePoint resolves list GUIDs within the selected site.
string
OData $orderby to sort results, e.g., ‘Title asc’.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_LIST_LIST_VIEWSList saved views for a SharePoint list selected by GUID or exact title, with optional OData projection, filtering, sorting, and offset pagination.

Input Parameters

integer
Maximum number of views to return in this page.
integer
Zero-based number of views to skip for offset pagination.
string
OData $filter expression used to narrow views.
string
Comma-separated OData $select projection of view properties.
string
Canonical GUID of the SharePoint list. Provide exactly one of list_id or list_title.
string
OData $orderby expression used to sort views.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
Exact display title of the SharePoint list. Provide exactly one of list_id or list_title.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_LIST_MEDIA_TRANSCRIPTSList transcript metadata for a media item in the selected SharePoint site’s or explicit OneDrive personal site’s default drive, without downloading transcript content. This action does not support an arbitrary drive ID.

Input Parameters

string
Comma-separated transcript metadata properties to return. Raw transcript content properties cannot be selected.
string
required
Drive item ID of the media file in the selected SharePoint site’s or explicit OneDrive personal site’s default drive. Arbitrary drives cannot be selected.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
Exact SharePoint site root returned by Microsoft, used primarily for OneDrive for Business personal sites, for example ‘https://contoso-my.sharepoint.com/personal/alex_contoso_com’. Do not pass a page, library, _api URL, query, or fragment. Do not combine with site_name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_LIST_NAVIGATION_CHILDRENList child navigation nodes beneath a specified SharePoint navigation node.

Input Parameters

string
OData $expand expression for related navigation-node properties.
string
Comma-separated OData $select projection of navigation-node properties.
integer
required
Positive ID of the parent SharePoint navigation node.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_LIST_QUICK_LAUNCH_NAVIGATIONList a site’s SharePoint Quick Launch navigation nodes.

Input Parameters

string
OData $expand expression for related navigation-node properties. Defaults to Children; pass null to omit expansion.
string
Comma-separated OData $select projection of navigation-node properties.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_LIST_RECYCLE_BIN_ITEMSTool to list items in the SharePoint Recycle Bin. Use when you need to retrieve deleted items and page through results.

Input Parameters

integer
Maximum number of items to return.
string
Comma-separated list of navigation properties to expand (e.g., Author,DeletedBy).
string
OData filter expression to filter items (e.g., ItemState eq 1).
string
Comma-separated list of fields to include in the response (e.g., Id,Title,DeletedDate).
string
OData orderby expression to sort results (e.g., DeletedDate desc).
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
Token for server-driven pagination. Extract this value from the @odata.nextLink or pagination token in the previous response and pass it into the next call to retrieve subsequent pages.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_LIST_SCOPED_ROLE_ASSIGNMENTSList a page of principals and expanded permission-level bindings on a SharePoint list or list item. The delegated user must have a permission level containing Enumerate Permissions on the selected resource; the response does not expose a continuation token.

Input Parameters

integer
Positive list-item ID. Omit to list assignments on the list itself.
string
GUID of the selected list. Provide exactly one of list_id or list_title.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
Exact title of the selected list. Provide exactly one of list_id or list_title.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_LIST_SITE_DRIVESList a page of document libraries (drives) accessible in a SharePoint site, including default and custom libraries. The requested page size defaults to 25.

Input Parameters

integer
OData $top parameter - number of drives to return. Default: 25.
string
OData $expand parameter to expand related entities (e.g., ‘root,items’).
string
OData $select parameter - comma-separated properties to return (e.g., ‘id,name,webUrl,driveType’).
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_LIST_SITE_FIELDSList reusable web-level SharePoint fields (site columns). Use this action to discover schema shared across lists in a selected site; use SHARE_POINT_LIST_LIST_COLUMNS for fields attached to one list.

Input Parameters

integer
Maximum number of fields to return. For pagination, combine with skip and increase skip by top until a page contains fewer than top fields.
integer
Zero-based number of fields to skip for offset pagination.
string
OData $filter expression used to narrow fields.
string
Comma-separated OData $select projection of field properties, e.g., ‘Id,Title,InternalName,FieldTypeKind’.
string
OData $orderby expression used to sort fields.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_LIST_SITE_GROUPSTool to list SharePoint site groups for a site collection. Use when you need to see all groups and their settings before managing permissions.

Input Parameters

integer
OData $top clause to limit the number of returned groups.
integer
OData $skip clause for paging, number of results to skip.
string
OData $expand clause to pull in navigation properties like Users or Owner.
string
OData $filter clause to filter results. Example: “substringof(‘Owners’,Title)”
string
OData $select clause to specify which group fields to return. Example: ‘Title,Id’
string
OData $orderby clause to sort results. Example: ‘Title desc’
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_LIST_SITE_PAGESList one provider page of modern SharePoint site pages, optionally filtering or selecting fields. This action returns next_link when more provider pages exist but does not retrieve that continuation itself.

Input Parameters

string
OData $filter expression used to narrow the returned pages.
string
Comma-separated OData $select projection of page properties.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_LIST_SITESSearch for SharePoint sites accessible to the user. Returns a limited set of search results, with an optional query and result limit.

Input Parameters

integer
Number of sites to return. Maximum value is 500.
Search query to filter sites by name or description. Use ’*’ to get all sites.
string
Comma-separated list of managed property names to return. Common properties: SiteId, SiteName, Title, Path, Description, Created, LastModifiedTime. If not specified, SharePoint returns a default set of properties.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_LIST_SITE_USERSTool to list users in the site collection. Results include person users, groups, and system principals by default; use filter ‘PrincipalType eq 1’ to restrict to individual users.

Input Parameters

integer
OData top to limit the number of results.
string
OData expand to include related entities, e.g., ‘Groups’.
string
OData filter to narrow results, e.g., ‘PrincipalType eq 1’. substringof filters are case-sensitive; normalize casing in filter values to avoid missing valid matches.
string
OData select to specify which user fields to return, e.g., ‘Title,Email’. Email can be empty for some users; prefer LoginName or Id for reliable identification.
string
OData orderby to sort results, e.g., ‘Title asc’.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
OData skiptoken for paging through results. Iterate requests following each returned skiptoken until no further skiptoken is returned to retrieve all users.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_LIST_SUBFOLDERS_IN_FOLDERTool to list immediate child folders within a SharePoint folder. Use when you need folder navigation or directory discovery by server-relative URL.

Input Parameters

integer
OData $top to limit the number of subfolders returned.
string
OData $select to specify which folder properties to return (comma-separated).
string
OData $orderby to sort the results (e.g., ‘Name desc’).
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
required
Server-relative URL of the parent folder, e.g., ‘/Shared Documents’ or ‘/sites/MySite/Folder’. Must be a valid path to an existing folder. For folders with special characters (#, %), the action will automatically use the ResourcePath-based endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_LIST_WEB_ROLE_ASSIGNMENTSList principals assigned SharePoint permission levels on a web/site, including each principal and its bound role definitions. Delegated users must have a SharePoint permission level containing Enumerate Permissions on the selected web, such as Full Control or Manage Hierarchy. Use this for SharePoint role assignments, not file sharing links.

Input Parameters

integer
Maximum number of role assignments to request in this page.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
Opaque next_link returned by a previous call. Pass it back unchanged and do not combine it with top.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_LOG_EVENTLog a SharePoint usage analytics event for a user activity, such as a document view, edit, or custom interaction, for usage reporting.

Input Parameters

string
required
User identifier who triggered the event. Can be email address (user@domain.com), display name, or SharePoint LoginName (i:0#.f|membership|user@domain.com).
string
required
GUID of the item (document, list item, or web) related to this event. Can be a document ID, list item ID, web ID, or site collection ID.
string
required
GUID of the site collection where the event occurred. Use the site collection ID from GET /api/site.
string
required
GUID defining the scope/context of the event. Typically the web ID or site collection ID where the event occurred.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
integer
required
ID of the usage event type. Valid values are typically 1-4 for different SharePoint event types (e.g., 1=View, 2=Edit, 3=Custom). Use values 1-4 for standard tracking events.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_MOVE_ITEM_BY_PATHMove an existing SharePoint file or folder to a new server-relative path. Set overwrite only when an item at the destination may be replaced.

Input Parameters

string ("file" | "folder")
Whether the source item is a file or folder.
boolean
For files only. Whether to replace an item already present at the destination path.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
required
Decoded server-relative path of the existing file or folder to move. Start with ’/’ and include the document library name.
string
required
Decoded server-relative destination path, including the new file or folder name. Start with ’/’ and include the document library name.
boolean
For files only. Allow the move even when it breaks a thicket relationship (SharePoint MoveOperations flag 8).
boolean
For files only. Bypass the approval-permission check for the move (SharePoint MoveOperations flag 64).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_PUBLISH_SITE_PAGEPublish the latest version of a modern SharePoint site page by its positive item ID.

Input Parameters

integer
required
Positive list item ID of the modern SharePoint site page to publish.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_QUERY_LIST_ITEMSExecute a CAML query against a SharePoint list and return native list-item records.

Input Parameters

string
required
Canonical GUID of the SharePoint list.
string
Optional non-empty, well-formed CAML View XML sent as SP.CamlQuery.ViewXml.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
boolean
Optional SP.CamlQuery.DatesInUtc value.
boolean
Advanced provider-native SP.CamlQuery.AllowIncrementalResults value. Microsoft publishes this property without behavioral guidance; omit it unless replaying a known SharePoint CAML request.
string
Optional server-relative folder path that constrains the CAML query.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_RECYCLE_FILETool to move a file to the Recycle Bin. Use when you need to recycle a file after confirming its folder and filename paths.

Input Parameters

string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
required
Relative URL of the file within the folder to recycle, e.g., ‘document.docx’. Do not include a leading ’/’.
string
required
Server-relative URL of the folder containing the file to recycle, e.g., ‘/Shared Documents/Folder1’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_RECYCLE_LIST_ITEMTool 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.

Input Parameters

integer
required
Numeric ID of the list item to recycle.
string
required
GUID of the SharePoint list containing the target item, in canonical format (e.g., ‘01234567-89ab-cdef-0123-456789abcdef’).
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_REDEEM_SHARERedeem a SharePoint sharing link and grant the connected account durable access to the shared file or folder.

Input Parameters

string
Comma-separated relationships to expand, such as driveItem for sharing metadata or children for a shared folder’s drive item.
string
Comma-separated properties to return, such as id,name,webUrl.
string ("shared_drive_item" | "drive_item")
Resource to return. ‘shared_drive_item’ returns sharing metadata; ‘drive_item’ returns the shared file or folder directly.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
Exact SharePoint site root returned by Microsoft, used primarily for OneDrive for Business personal sites, for example ‘https://contoso-my.sharepoint.com/personal/alex_contoso_com’. Do not pass a page, library, _api URL, query, or fragment. Do not combine with site_name.
string
required
Share ID returned by the sharing API, or a sharing URL encoded as unpadded base64url with the ‘u!’ prefix.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_RENAME_FOLDERRenames a SharePoint folder by updating its list item metadata. To use this action: 1. Provide the folder path and new leaf folder name. 2. The action updates the folder list item fields needed by SharePoint. The rename operation updates both the folder’s display name (Title) and actual name (FileLeafRef). Note: This only changes the folder name, not its location in the hierarchy.

Input Parameters

string
required
New folder name (leaf name only, not full path). This will be used for both the display name (Title) and the actual folder name (FileLeafRef). Do not include path separators (/).
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
ETag value for concurrency control. Use ’*’ (default) to overwrite regardless of the current version. To enforce version checking, obtain the ETag from GET_FOLDER_BY_SERVER_RELATIVE_URL with expand=ListItemAllFields, then use the ‘__metadata.etag’ value.
string
OData entity type of the folder’s list item. Accepted for compatibility with older MERGE-style calls.
string
required
Server-relative path of the folder to rename, including library and any parent folders. Must start with ’/’ and include the document library name. Example: ‘/Shared Documents/OldFolder’ or ‘/Shared Documents/ParentFolder/OldFolder’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_RENDER_LIST_DATA_AS_STREAMRetrieve list items from SharePoint with rich metadata and formatting. Returns items in the ‘Row’ array along with pagination info (FirstRow, LastRow, NextHref). Supports CAML queries via ViewXml for filtering and sorting. Use this when you need list data with properly formatted field values, lookup fields, or managed metadata - more capable than standard OData endpoints.

Input Parameters

string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used. If omitted and list_server_relative_url starts with ‘/sites/{site}/’, the site is inferred from the path; nested subsites require their complete web path.
object
Body parameters to control rendering options for RenderListDataAsStream.
object
Optional query string parameters to control view behavior. See documentation for supported keys.
string
required
Server-relative URL of the list. When a site is provided per call or configured on the connection, enter a site-relative path such as ‘/Lists/Orders’. A path beginning with ‘/sites/’ selects that site. Without a site, the path is resolved from the tenant root.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_RESTORE_DRIVE_ITEM_VERSIONTool to restore a previous version of a SharePoint drive item. Use when you need to revert a file to an earlier version.

Input Parameters

string
required
The unique identifier of the drive containing the item
string
required
The unique identifier of the drive item (file or folder) to restore
string
required
The unique identifier or version number of the version to restore (e.g., ‘23.0’, ‘1.0’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_RESTORE_RECYCLE_BIN_ITEMTool to restore a SharePoint Recycle Bin item. Use when you need to recover a deleted item by providing its GUID.

Input Parameters

string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
required
GUID of the Recycle Bin item to restore. Must be a valid GUID string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_SEARCH_FILESSearch for files across all SharePoint sites and OneDrive using Keyword Query Language. Returns files matching the query with metadata like title, path, size, author, and modification time. Use this action when you need to discover files broadly across an organization without knowing specific drive IDs or site locations. Results are automatically filtered to show only document content types. A site_name changes the endpoint context but does not isolate results unless restrict_to_site_path is enabled or query contains an equivalent Path restriction. Use from_index and row_limit parameters to paginate through large result sets.

Input Parameters

string
required
The search query text. Can use Keyword Query Language (KQL) syntax for advanced filtering. Examples: ‘Q4 report’, ‘budget proposal’, ‘FileType:docx’, ‘Author:“John Doe”’. Use KQL properties like FileType, Author, LastModifiedTime, or Path to narrow results.
integer
Maximum number of file results to return per request. Default is 25.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used. This changes the SharePoint Search endpoint context but does not strictly isolate results; set restrict_to_site_path to true for strict site isolation.
integer
Zero-based index of the first result to return. Use for pagination (e.g., from_index=0 for page 1, from_index=25 for page 2 with row_limit=25). Compare TotalRows vs RowCount in the response to determine if additional pages exist.
string
Comma-separated list of managed property names to return in results. Common file properties: Title, Author, Path, Size, LastModifiedTime, FileType, FileName, FileExtension. If not specified, SharePoint returns a default set.
boolean
Limit results to the effective subsite URL using a KQL Path restriction. Requires site_name on the request or in the connection configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_SEARCH_QUERYSearch SharePoint content using Keyword Query Language (KQL). Returns documents, list items, folders, and other content matching your query. Supports filtering by properties (file type, author, date), pagination, and custom property selection. Results are nested under PrimaryQueryResult→RelevantResults→Table→Rows→Cells as Key/Value pairs requiring explicit extraction. Results are security-trimmed: inaccessible content never appears even if it exists. Use contentclass (e.g., STS_Site, STS_Web, STS_ListItem_DocumentLibrary) in querytext to isolate specific item types. A site_name changes the endpoint context but does not isolate results unless restrict_to_site_path is enabled or querytext contains an equivalent Path restriction.

Input Parameters

integer
Maximum number of results to return per request. Default is determined by SharePoint (typically 50). Maximum is 500.
integer
Zero-based index of the first result to return. Use for pagination (e.g., startrow=0 for page 1, startrow=10 for page 2 with rowlimit=10). Compare TotalRows vs RowCount in the response to determine if additional pages exist; increment startrow by rowlimit until all results are retrieved.
string
required
The search query using Keyword Query Language (KQL) syntax. Examples: ‘project report’, ‘IsDocument:1’, ‘FileType:docx’, ‘Author:“John Doe”’. Broad queries (e.g., ‘.xlsx’ alone) return noisy large result sets; narrow with site paths, Author, date ranges, or other KQL properties. Filter by contentclass to isolate specific item types.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used. This changes the SharePoint Search endpoint context but does not strictly isolate results; set restrict_to_site_path to true for strict site isolation.
string
Comma-separated list of managed property names to return in results. If not specified, SharePoint returns a default set of properties. Common properties: Title, Author, Path, Size, LastModifiedTime, FileType. Include SiteId and WebId alongside Path to disambiguate items sharing the same title across different locations.
string
Refinement filters to narrow search results. Format: ‘PropertyName:value’ or use FQL syntax for complex filters. Example: ‘FileType:equals(“docx”)’.
boolean
Limit results to the effective subsite URL using a KQL Path restriction. Requires site_name on the request or in the connection configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_SEARCH_SUGGESTTool to get search query suggestions. Use when you need to provide autocomplete options for user search input.

Input Parameters

integer
Locale ID (LCID) for the query.
string
required
Text for which to retrieve query suggestions.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
boolean
True to enable stemming.
boolean
True to enable query rules.
boolean
True to bold-match terms in suggestions.
boolean
True to get pre-query suggestions; false for post-query.
boolean
True to return suggestions matching all query prefixes.
boolean
True to capitalize first letters of each term.
boolean
True to include people name suggestions.
integer
Number of query suggestions to retrieve. Must be >= 1.
integer
Number of result suggestions to retrieve. Must be >= 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_SHAREPOINT_CHECK_OUT_FILETool to check out a file in a document library. Use when you need to lock a file before making changes.

Input Parameters

string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
required
The server-relative path to the file that needs to be checked out, e.g., ‘/Shared Documents/a.txt’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_SHAREPOINT_CREATE_FOLDERCreate a folder in a SharePoint document library and return its server-relative URL; if the folder already exists, the action can return the existing folder instead. It does not configure sharing or permissions.

Input Parameters

string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used. A complete ‘/sites/’ or ‘/teams/’ resource path determines the owning web even when site_name is supplied. An explicit site_name must identify that web or an ancestor; unrelated selectors return an error. Site-local paths use site_name or the connection’s saved site.
string
required
Decoded name of the folder to create. Literal ’%’ and ’#’ characters are preserved. SharePoint names cannot contain double quotes, *, :, <, >, ?, /, backslash, or |.
string
Decoded path below the document-library root, for example ‘Projects/2025’. The parent path must already exist. Plain spaces are accepted; do not pre-encode them as %20.
string
Root-folder URL segment of the target document library, for example ‘Shared Documents’. This may differ from its display title, such as ‘Documents’. To target a nested subsite from a parent-site connection, include the child path, such as ‘subweb01/Shared Documents’; the action resolves the deepest owning web. An explicit site_name must identify that web or an ancestor; unrelated selectors return an error.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_SHAREPOINT_CREATE_LISTCreates a SharePoint list from a specified template, name, and optional description. Returns a creation message, list ID, title, and description; custom columns are not supplied at creation.

Input Parameters

string
required
The name of the list to create. Must be unique per site; duplicate names cause failure. Pre-check with SHARE_POINT_GET_LIST_BY_TITLE or SHARE_POINT_LIST_ALL_LISTS before calling.
string
required
The template type for the list (e.g., ‘genericList’, ‘documentLibrary’, ‘tasks’, etc.).
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
Description of the list (optional).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_SHAREPOINT_CREATE_LIST_ITEMCreates a new item in a SharePoint list selected by title. Returns the created item data along with a separate item ID and creation timestamp.

Input Parameters

string
required
The name or title of the list where the item will be created. Must exactly match the list’s title as it exists in the site; verify the list exists first using SHARE_POINT_SHAREPOINT_CREATE_LIST if uncertain.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
object
required
Dictionary of field names and values for the list item. Example: {‘Title’: ‘New Item’, ‘Body’: ‘Content’} Keys must be SharePoint column internal names (not display names); use the SharePoint column settings to find internal names. The example key ‘Body’ is invalid on default lists — use ‘Title’ as the minimal valid payload and add fields one at a time to isolate errors.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_SHAREPOINT_CREATE_USERDEPRECATED: Use SHARE_POINT_ENSURE_USER instead (supports email param directly). Adds an existing Azure AD user to the SharePoint site collection using the ensureuser endpoint. This action is idempotent - if the user is already in the site, it returns their existing details without error.

Input Parameters

string
required
Email address of the Azure AD user to add to SharePoint site. Must be a valid user in your organization’s Azure Active Directory.
string
Optional display name/title for the user in SharePoint. If not provided, the user’s existing display name from Azure AD will be used.
string
DEPRECATED: This parameter is no longer used. The tenant is now automatically derived from the connected account’s base_url in metadata.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
Optional login name for the user. If not provided, defaults to ‘i:0#.f|membership|{email}’. This parameter is typically not needed as the email is sufficient.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_SHAREPOINT_FIND_USERLook up a user in a SharePoint site by email and return available user details. Check user_exists and error_message together: lookup errors can also produce user_exists=false.

Input Parameters

string
required
Email address of the user to find. Must be a complete, valid email address — display names and short names are rejected and return ‘User not found’. Use SHARE_POINT_LIST_SITE_USERS to resolve a display name to an email first.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_SHAREPOINT_REMOVE_USERRemoves a user from SharePoint. Returns success even if user doesn’t exist or was never a member; check response fields was_removed (bool) and message (str) to distinguish an actual removal from a no-op.

Input Parameters

string
required
Email address of the user to remove.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_UNDO_CHECKOUT_FILETool to undo a file checkout, discarding any changes made while checked out. Use when you need to cancel edits and unlock the file without saving.

Input Parameters

string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
required
Server-relative URL of the file to undo checkout, including library and folders. E.g., ‘/Shared Documents/test_undocheckout.txt’. This will discard any changes made while checked out.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_UPDATE_CONTENT_TYPETool to update a SharePoint content type’s properties such as name, description, group, or hidden status. Use when you need to modify content type metadata.

Input Parameters

string
The name of the content type. Use this to rename the content type.
string
The group name that this content type belongs to. Use this to change the group classification.
boolean
Indicates whether the content type is hidden in the list’s New menu. Set to true to hide the content type.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
The descriptive text for the content type. Use this to update the content type description.
object
Model for document set metadata.
string
required
The unique identifier of the content type to update. This can be the content type ID (e.g., ‘0x01’ for Item) or the string ID from the Id.StringValue property.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_UPDATE_DRIVE_ITEMUpdate a SharePoint file or folder’s name or title by server-relative path. When a name is supplied without a title, the title is also set to the new name.

Input Parameters

string
The new name for the item (filename with extension for files, folder name for folders). Use to rename the file or folder.
string
The new title for the item. This updates the Title field of the list item.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
required
The server-relative URL of the file or folder to update (e.g., ‘/Shared Documents/file.docx’ or ‘/sites/mysite/Shared Documents/folder’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_UPDATE_FILE_ITEMTool to update metadata fields on a SharePoint file item via its ListItemAllFields. Use this action when you need to modify document properties, custom columns, or metadata without changing the file content itself. This operates on the list item behind the file, allowing you to set Title, Status, Owner, Categories, or any other library column.

Input Parameters

string
ETag value for concurrency control. Use ’*’ to force update regardless of version. Provide a specific ETag to ensure safe concurrent updates. Format: ‘“guid,version”’ like ‘“c7a93369-bda8-4da1-b1a3-3d87d2e207fc,1”’.
object
required
Dictionary mapping internal field names to their new values. Supports text, numbers, booleans, dates, and complex types for lookup/person fields. For lookup and person/group fields, append ‘Id’ to the field name and provide the ID as an integer (single-value) or {‘results’: [id1, id2, …]} for multi-value (OData verbose format). Internal field names with spaces are encoded with ‘x0020’ (e.g., ‘Related_x0020_Item’ for ‘Related Item’).
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
required
Server-relative URL of the file to update, starting with ’/’. E.g., ‘/Shared Documents/report.pdf’ or ‘/sites/Finance/Documents/W-9.pdf’.
string
The ListItemEntityTypeFullName required for __metadata.type in the request body. If not provided, it will be fetched automatically. Format: ‘SP.Data.{ListName}ListItem’ like ‘SP.Data.Shared_x0020_DocumentsItem’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_UPDATE_LISTTool to update properties of an existing SharePoint list. Use when you need to modify list metadata such as title, description, or settings like versioning and attachments.

Input Parameters

string
New title for the list. Provide this to rename the list.
string
ETag value for concurrency control. Use ’*’ to force update regardless of version. Provide a specific ETag to ensure safe concurrent updates.
string
required
GUID of the SharePoint list to update, in canonical format (e.g., ‘a12e3d6e-9414-462d-bd53-cf06f3982ad3’).
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
New description for the list. Provide this to update the list description.
boolean
Whether versioning is enabled for the list. Set to true to enable, false to disable.
boolean
Whether attachments are enabled for list items. Set to true to enable, false to disable.
boolean
Whether content types are enabled for the list. Set to true to enable, false to disable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_UPDATE_LIST_FIELDUpdate one or more mutable properties of an existing SharePoint list field identified by list and field GUID. Provide at least one of title, description, required, hidden, indexed, or enforce_unique_values. This changes the field schema for the selected list.

Input Parameters

string
New non-empty display name for the field.
boolean
Whether the field is hidden from standard SharePoint forms.
boolean
Whether SharePoint indexes this field.
boolean
Whether list items must provide a value for this field.
string
required
Canonical GUID of the SharePoint list containing the field.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
required
Canonical GUID of the existing SharePoint field to update.
string
New field description. Pass an empty string to clear it.
boolean
Whether values must be unique. Setting this to true also enables indexing when indexed is omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_UPDATE_LIST_ITEMUpdate fields on an existing SharePoint list item via MERGE. An ETag can be supplied for concurrency control; the default wildcard updates regardless of version.

Input Parameters

string
ETag value for concurrency control. Use ’*’ to force update regardless of version. Provide a specific ETag (from GET_LIST_ITEM_ETAG tool) to ensure safe concurrent updates. Format: ‘“guid,version”’ like ‘“c7a93369-bda8-4da1-b1a3-3d87d2e207fc,1”’.
object
required
Dictionary mapping internal field names to their new values. Supports text, numbers, booleans, dates, and complex types for lookup/person fields. For lookup and person/group fields, append ‘Id’ to the field name and provide the ID as an integer (single-value) or {‘results’: [id1, id2, …]} for multi-value (OData verbose format). Internal field names with spaces are encoded with ‘x0020’ (e.g., ‘Related_x0020_Item’ for ‘Related Item’).
integer
required
Numeric ID of the list item to update.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
required
The exact title of the SharePoint list containing the item to update.
string
The ListItemEntityTypeFullName required for __metadata.type in the request body. If not provided, it will be fetched automatically using GET_LIST_ITEM_ENTITY_TYPE_FULL_NAME. Format: ‘SP.Data.{ListName}ListItem’ like ‘SP.Data.TasksListItem’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_UPDATE_LIST_VIEW_FIELDSAdd, move, or remove all fields in one SharePoint list view selected by GUID or title.

Input Parameters

integer
Zero-based destination index required by move.
string
Canonical GUID of the SharePoint list containing the view.
string
Canonical GUID of the SharePoint list view to modify.
string ("add" | "move" | "remove_all")
required
View-field mutation: add a field, move a field to an index, or remove all fields.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
Internal field name required by add and move.
string
Exact title of the SharePoint list containing the view.
string
Exact title of the SharePoint list view to modify.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_UPDATE_SITETool to update properties of the current SharePoint site (web). Use when you need to modify site title, description, or other SP.Web properties via MERGE.

Input Parameters

string
The new title for the site. If not provided, the title will not be updated.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
The new description for the site. If not provided, the description will not be updated.
boolean
Whether the tree view is enabled on the site.
boolean
Whether the Quick Launch navigation is enabled on the site.
boolean
Whether to enable minimal download strategy for the site.
boolean
Whether the ‘Save Site as Template’ feature is enabled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_UPDATE_SITE_DRIVE_ITEMRename or move a SharePoint site drive item, or set its client file-system timestamps, and return the updated item.

Input Parameters

string
New file or folder name.
string
required
ID of the file or folder to update.
string
required
Opaque site ID from driveItem.parentReference.siteId.
string
Optional eTag or cTag concurrency precondition.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
ID of a new parent folder in the same drive. Use the actual root-folder ID rather than the literal value ‘root’.
object
Optional client-created or client-modified timestamps.
string
Exact SharePoint site root returned by Microsoft, used primarily for OneDrive for Business personal sites, for example ‘https://contoso-my.sharepoint.com/personal/alex_contoso_com’. Do not pass a page, library, _api URL, query, or fragment. Do not combine with site_name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_UPDATE_SITE_FIELDUpdate mutable properties of an existing SharePoint site field by GUID, changing reusable web-level schema for the selected site. Enabling unique values also enables indexing when indexing is omitted.

Input Parameters

string
New non-empty display name for the site field.
boolean
Whether the site field is hidden from the user interface.
boolean
Whether SharePoint indexes this site field.
boolean
Whether values are required for this site field.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
required
Canonical GUID of the existing SharePoint site field to update.
string
New site field description. Pass an empty string to clear it.
boolean
Whether values must be unique. Setting this to true also enables indexing when indexed is omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_UPLOAD_FILETool to upload a file to a SharePoint document library or folder. Use when you need to programmatically add or update a file in a document library.

Input Parameters

object
File to upload. Alternatively, omit this and provide either ‘content_text’ for UTF-8 text or ‘content_base64’ for arbitrary bytes along with ‘file_name’ to set the filename.
string
Decoded filename to use when ‘file’ is not provided. Literal ’%’ and ’#’ characters are preserved. SharePoint names cannot contain double quotes, *, :, <, >, ?, /, backslash, or |.
boolean
Whether to overwrite an existing file with the same name. Defaults to true.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used. A complete ‘/sites/’ or ‘/teams/’ resource path determines the owning web even when site_name is supplied. An explicit site_name must identify that web or an ancestor; unrelated selectors return an error. Site-local paths use site_name or the connection’s saved site.
string
Optional raw text content to upload (UTF-8 encoded). Use when not passing ‘file’.
string
Optional base64-encoded bytes to upload. Use for binary content when not passing ‘file’.
string
required
Decoded destination folder path, starting with ’/’. A site-local path such as ‘/Shared Documents’ is expanded under site_name. A complete server-relative path such as ‘/sites/parent/child/Shared Documents’ is also accepted and selects its deepest owning web, even when site_name is omitted or names a parent web. An explicit site_name must identify the owning web or an ancestor; unrelated selectors return an error. Literal percent sequences are preserved; use spaces directly rather than pre-encoding them as %20.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_UPLOAD_FROM_URLFetch a file from a URL and upload it to SharePoint. Conflict behavior can be set to replace, fail, or rename; it defaults to replace, which can overwrite an existing file.

Input Parameters

string
Explicit SharePoint site ID (e.g., contoso.sharepoint.com,2C712604-…,2D2244C3-…). Takes precedence over site_name and the connection-configured site. If drive_id is also provided, both explicit IDs are used; otherwise this site’s default drive is used.
string
Explicit drive ID where the file should be uploaded. Takes precedence over site_name and the connection-configured site. When site_id is also provided, selects that drive within the explicit site; otherwise selects the drive directly. If omitted, uses the selected site’s default document library.
string
required
The URL of the file to download and upload to SharePoint. Must be accessible from the server.
string
Name for the uploaded file. If not provided, extracts from the URL or Content-Disposition header.
boolean
DEPRECATED. Use ‘conflict_behavior’ instead. true → ‘replace’, false → ‘fail’. Ignored if ‘conflict_behavior’ is set.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used. This value is ignored when either site_id or drive_id is provided; explicit IDs take precedence.
string
Decoded folder path relative to the selected drive root. Do not include the document-library name when that library is the drive itself. For example, use ‘Projects’, not ‘Documents/Projects’, unless a folder literally named ‘Documents’ exists inside the drive root. Defaults to the drive root.
object
Optional HTTP headers to include when downloading from file_url. Use for authentication tokens, signed URLs, or CDN-specific headers.
string ("fail" | "replace" | "rename")
Specifies how to handle name conflicts when uploading files to SharePoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_UPLOAD_LARGE_FILECreate a direct-v2 upload session and upload one file in sequential chunks.

Input Parameters

object
File to upload. Its name is used as the destination filename. Provide exactly one of file, content_text, or content_base64.
string
required
ID of the destination drive.
string
Destination filename required with content_text or content_base64. Omit when file is provided because file.name is used.
string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
string
UTF-8 text to upload instead of file or content_base64.
string
Strict base64-encoded bytes to upload instead of another source.
string
ID of the destination parent folder. Omit to resolve relative_item_path from the drive root.
integer
Bytes per upload fragment. Defaults to 10 MiB and must be no more than 60 MiB and a multiple of 320 KiB.
string ("fail" | "replace" | "rename")
Behavior when the destination file already exists.
string
required
Relative destination folder path beneath the selected parent item or drive root, for example ‘Reports/2026’. Use an empty string to upload directly beneath the selected parent. The source filename is appended.
string
Exact SharePoint site root returned by Microsoft, used primarily for OneDrive for Business personal sites, for example ‘https://contoso-my.sharepoint.com/personal/alex_contoso_com’. Do not pass a page, library, _api URL, query, or fragment. Do not combine with site_name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_VALIDATE_AND_UPDATE_DOCUMENT_FIELDSValidate and commit document-library field values for a SharePoint file. Inspect every returned HasException and ErrorMessage because HTTP 200 can include rejected fields.

Input Parameters

string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.
array
required
Non-empty list of field internal-name and string-value pairs to validate and commit.
string
Check-in comment to use when the document is checked out.
string
required
Decoded server-relative path of the document, starting with ’/’. For example, ‘/Shared Documents/report.docx’.
boolean
Whether this field update immediately follows document upload.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHARE_POINT_VALIDATE_CREDENTIALValidate SharePoint credentials by attempting to retrieve the current user information. Use this action during setup or configuration to verify that provided credentials have valid access to the SharePoint site before performing other operations.

Input Parameters

string
Optional per-call site override. Provide the complete server-relative path to the SharePoint site or subsite web root, such as ‘/sites/marketing/archive’ or ‘/teams/engineering’, or provide a same-origin full URL to that web root. Do not pass a page, library, list, folder, or other resource URL. A bare name such as ‘marketing’ maps to ‘/sites/marketing’, so nested subsites require their complete path. If omitted, the site configured on the connection is used; if none is configured, the tenant root site is used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not