Get Site
sharepoint.get_site
ActionFiles & storageconnection required
Calls the SharePoint API with the connection's credentials.
Read one site's metadata by site id, by hostname and server-relative path, or the tenant root site when neither is given.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- OAuth 2.0
- Providers
- SharePoint
- Secret shape
- {"client_id": "…", "client_secret": "…", "refresh_token": "…"} with the Sites.ReadWrite.All delegated scope
- Config it needs
- tenant, site_id
- Resolved by
- config.connection_id, else node.connection_id
Configuration
3 fields, none required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
site_id The site id, as 'hostname,siteCollectionId,siteId'. Leave blank to use hostname + site_path, or neither for the tenant root site. | string | No | — | — | — |
hostname The SharePoint hostname, e.g. 'contoso.sharepoint.com'. Used with site_path when site_id is blank. | string | No | — | — | — |
site_path Server-relative path of the site, e.g. 'sites/marketing'. Requires hostname. | string | No | — | — | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
id The site id to use in later steps. | string | — |
name The site's URL name. | string | — |
display_name The site's human title. | string | — |
description The site description. | string | — |
web_url Browser URL for the site. | string | — |
created ISO-8601 timestamp of creation. | string | — |
last_modified ISO-8601 timestamp of the last change. | string | — |
{
"created": "",
"description": "",
"display_name": "",
"id": "",
"last_modified": "",
"name": "",
"web_url": ""
}See Get Site run in a workflow.
In a technical demo we add the SharePoint connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.