List lists with the SharePoint API
Lists the lists and document libraries of a site, with id, name, displayName, webUrl and list.template, which is genericList for a list and documentLibrary for a library. Hidden system lists are left out. Only the first page comes back.
- Identifier
- sharepoint_list_lists
The request
POST https://connect.reportei.com/api/tools/sharepoint_list_lists/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"site_id": "<site_id>"
}
}Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| site_id | string | Yes | Site id from Search sites, in the form hostname,guid,guid, or root for the root site of the organization. |
Supported connections
Your customer connects their SharePoint account once, with one of the modes below. The same connection serves every tool of the toolkit.
OAuth with your product's app
You register your product's OAuth app once, with POST /api/merchants/credentials/sharepoint, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.
The response
On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.
Ready for AI agents
This tool's input is a JSON Schema, available at GET /api/tools/sharepoint_list_lists. It becomes your agent's tool definition with no conversion.
Other SharePoint tools
- Search sitesGETSearches the SharePoint sites of the organization by keyword and returns id, displayName, name, webUrl and description. Use the id as site_id. Only the first page comes back.
- Get siteGETReturns one site with id, displayName, name, description, webUrl and createdDateTime.
- List columnsGETLists the columns of a list with name, displayName, required, readOnly and the facet of its type, such as text, number, dateTime, boolean or choice with the allowed choices. The name, not the displayName, is the key of a column in fields.
- List itemsGETLists the items of a list with id, webUrl, createdBy and lastModifiedDateTime, plus the column values in fields when expand is fields. In a document library each item is a file or folder. Only the first page comes back.
- Get itemGETReturns one item of a list with id, webUrl, createdBy and lastModifiedDateTime, plus the column values in fields when expand is fields.
- Create itemPOSTCreates an item in a list and returns it with its id and the values saved. Every required column of List columns must be in fields.
- Delete itemDELETEDeletes an item from a list.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
