SharePoint - Get Item By Path
What it does
Find a file or folder by its path inside an approved SharePoint document library and return its metadata and Item ID.
Paths are relative to the document library root. Do not include the SharePoint site URL or the document library name.
When to use it
- You know a predictable library-relative file or folder path.
- Resolve a path to an Item ID before rename, move, delete, or metadata operations.
You know a predictable library-relative file or folder path.
Requirements
- A connected Microsoft 365 connection for this HighLevel Location.
- The Drive ID of the approved SharePoint document library.
- A path relative to the document library root.
Inputs
| Input | Type | Required | Description | Example value |
|---|---|---|---|---|
Document Library (Drive ID) | string | Yes | Microsoft Graph Drive ID for the SharePoint document library. The Drive ID identifies the library itself and can be reused across workflow actions. | b!exampleDriveId123 |
Item Path | string | Yes | Path to a file or folder inside the selected document library, for example Customers/Acme Ltd/contract.pdf. Do not include the document library name. | Customers/Example Client/Brief.pdf |
Example values
- Document Library (Drive ID)
b!exampleDriveId123- Item Path
Customers/Example Client/Brief.pdf
Example workflow
- HighLevel workflow trigger
The business event that starts the workflow.
- SharePoint - Get Item By Path
Run the SharePoint operation with the approved Drive ID and action-specific inputs.
- Use the confirmed result
Map only the documented outputs required by the next workflow step.
A common pattern is: workflow builds a path → Get Item By Path → map Item ID into Rename Item, Move Item, Delete Item, or Get Item.
Outputs
| Output | Type | Description | Example value | Use in later steps |
|---|---|---|---|---|
Success | boolean | Confirms that the action completed successfully. | true | Use as a completion checkpoint before relying on other outputs. |
Item ID | string | Microsoft Graph DriveItem ID of the resulting file or folder. | example-item-id | Map into Get Item, Move Item, Rename Item, Delete Item, or other ID-based steps. |
Item Name | string | Current name of the file or folder. | Example Document.pdf | Use for confirmation, messages, or later naming logic. |
Web URL | string | SharePoint web link for the resulting file or folder. | https://example.invalid/Clients/Example/Example%20Document.pdf | Use when a later step or staff member needs the SharePoint link. |
Item Type | string | Normalized item type such as file or folder. | file | Use to distinguish file and folder results. |
Size | numerical | Item size in bytes. | 24576 | Use for file-size checks or audit information. |
MIME Type | string | MIME type for a file when Microsoft returns one. | application/pdf | Use when later logic depends on the returned file type. |
Last Modified | date | Microsoft last-modified timestamp for the item. | 2026-09-22T20:00:00Z | Use for audit or freshness checks. |
Parent Item ID | string | DriveItem ID of the resulting parent folder. | example-parent-folder-id | Use when later logic needs the resulting parent folder ID. |
How to use outputs in later HighLevel steps
Success: Use as a completion checkpoint before relying on other outputs.Item ID: Map into Get Item, Move Item, Rename Item, Delete Item, or other ID-based steps.Item Name: Use for confirmation, messages, or later naming logic.Web URL: Use when a later step or staff member needs the SharePoint link.Item Type: Use to distinguish file and folder results.Size: Use for file-size checks or audit information.MIME Type: Use when later logic depends on the returned file type.Last Modified: Use for audit or freshness checks.Parent Item ID: Use when later logic needs the resulting parent folder ID.
The most reusable output is Item ID. The action also returns the item name, type, web link, size, MIME type, modified time, and parent ID.
Permissions required
- Microsoft Graph application permission Sites.Selected on the customer-owned Entra app.
- The SharePoint site containing the document library must grant the app at least read access for this operation.
- The action does not require tenant-wide SharePoint access merely for discovery or name matching.
Common errors
Authentication unavailable / 401- This HighLevel Location does not have a usable Microsoft connection. Verify the Location connection before changing SharePoint permissions.
403- The Entra app lacks access to the selected SharePoint site or the granted role is too narrow for the operation. Verify Sites.Selected consent and the site's read grant.
404- The Drive ID, folder path, or Item ID does not resolve in the connected tenant and approved site. Recheck the administrator's Drive ID map and the exact path or Item ID.
429- Microsoft Graph throttled the request. Retry later and avoid high-volume loops without bounds.
Related actions
Product/action version
- Product version
- Pre-launch technical release · 2026-10-04
- Action version
- 1.1
- Implementation reference
- Integration commit 8440a0f · src/modules/workflows/actions/sharepoint-get-item-by-path.json · code/sharepoint_get_item_by_path.1.1.js