Get List
sharepoint.get_list
ActionFiles & storageconnection required
Calls the SharePoint API with the connection's credentials.
Read one list's metadata, including its template and web URL.
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
2 fields, 2 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 that holds the list, as 'hostname,siteCollectionId,siteId'. Use sharepoint.get_site or sharepoint.search_sites to find it. | string | Yes | — | — | — |
list_id The list's id or its name, both of which Graph accepts in the path. | string | Yes | — | — | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
id The list id. | string | — |
name The list's URL name. | string | — |
display_name The list's human title. | string | — |
description The list description. | string | — |
web_url Browser URL for the list. | string | — |
template The list template, e.g. 'genericList'. | string | — |
last_modified ISO-8601 timestamp of the last change. | string | — |
{
"description": "",
"display_name": "",
"id": "",
"last_modified": "",
"name": "",
"template": "",
"web_url": ""
}See Get List 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.