> ## Documentation Index
> Fetch the complete documentation index at: https://squad.so/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# SharePoint
> What agents can do in SharePoint at each access level, and how to connect, limit, and disconnect SharePoint.
Connect SharePoint so your agents can work in your SharePoint account. You choose an access level for each account, and Squad refuses any agent action outside that level.
## Access levels
Each SharePoint account has an access level: **Read-only**, **Read + write**, and **Full access**. Squad refuses any agent action outside that level. You can also narrow or block single agents under **Per-agent access**.
| Level | The connect window describes this level as | Actions agents can use |
| ------------------------------ | ----------------------------------------------- | ---------------------- |
| **Read-only** | "Read SharePoint sites and files." | 27 of 105 |
| **Read + write** (recommended) | "Read and write site content and list items." | 96 of 105 |
| **Full access** | "Manage site permissions, create/delete sites." | 105 of 105 |
**Read + write** is the recommended level. The connect window selects it for you, and you can choose another level.
The SharePoint sign-in page asks you to approve full access to your account. This is expected. Squad does not narrow the sign-in. It checks every agent action against the level you chose, and it refuses actions outside that level.
## What agents can do at each level
Each level opens with a short summary in plain tasks, then lists every action it adds, grouped by what the action works on. You do not need to name actions. Ask in plain words, and the agent searches for the matching action.
**Find an action.** Open a level and use your browser's find (Ctrl+F, or Cmd+F on a Mac) with a word from the task or part of a slug. Or ask your agent in plain words, for example "What can you do in my SharePoint account?" The agent can search the SharePoint actions for you.
Each action shows its name, a one-line description where the SharePoint action catalog has one, and its slug. The slug is the ID that agents use when they call the action.
Agents can use 27 of the 105 SharePoint actions at this level:
* View list items
* View content
* View files
* View and run lists
* View users
* View attachments
* View drives
* View folders
* View followers
* View groups
* Search queries
* View roles and permissions
All 27 actions at this level:
| Works on | Action | What it does | Slug |
| ------------------------- | ------------------------------------- | ----------------------------------------------------------------------------------- | --------------------------------------------------- |
| **Attachments** | List item attachments | List all attachments for a SharePoint list item. | `SHARE_POINT_LIST_ITEM_ATTACHMENTS` |
| **Content** | Get item attachment content | Download an attachment from a SharePoint list item. | `SHARE_POINT_GET_ITEM_ATTACHMENT_CONTENT` |
| | Get site page content | Retrieve modern SharePoint Site Pages content by reading list item fields. | `SHARE_POINT_GET_SITE_PAGE_CONTENT` |
| **Drives** | List drive children | List children (files and folders) in a SharePoint drive using REST API v2.0. | `SHARE_POINT_LIST_DRIVE_CHILDREN` |
| | List drives rest API | Retrieve drives using SharePoint REST API v2.0. | `SHARE_POINT_LIST_DRIVES_REST_API` |
| | List site drives | | `SHARE_POINT_LIST_SITE_DRIVES` |
| **Files** | Download file by server relative URL | Download a file by server-relative URL. | `SHARE_POINT_DOWNLOAD_FILE_BY_SERVER_RELATIVE_URL` |
| | List files in folder | List files within a SharePoint folder (non-recursive. | `SHARE_POINT_LIST_FILES_IN_FOLDER` |
| **Folders** | Get all folders | Retrieve all folders in the SharePoint web. | `SHARE_POINT_GET_ALL_FOLDERS` |
| | List subfolders in folder | List immediate child folders within a SharePoint folder. | `SHARE_POINT_LIST_SUBFOLDERS_IN_FOLDER` |
| **Followers** | Get my followers | Retrieves the list of users who are following the authenticated user in SharePoint. | `SHARE_POINT_GET_MY_FOLLOWERS` |
| **Groups** | List site groups | List SharePoint site groups for a site collection. | `SHARE_POINT_LIST_SITE_GROUPS` |
| **List items** | Get list items | Retrieve items from a SharePoint list. | `SHARE_POINT_GET_LIST_ITEMS` |
| | Get list items by guid | Retrieve items from a SharePoint list using its GUID. | `SHARE_POINT_GET_LIST_ITEMS_BY_GUID` |
| | List drive recent items | List recently modified items in a SharePoint drive using Microsoft Graph API. | `SHARE_POINT_LIST_DRIVE_RECENT_ITEMS` |
| | List recycle bin items | List items in the SharePoint Recycle Bin. | `SHARE_POINT_LIST_RECYCLE_BIN_ITEMS` |
| **Lists** | List all lists | Retrieves all lists in the current SharePoint web/site. | `SHARE_POINT_LIST_ALL_LISTS` |
| | Render list data as stream | Retrieve list items from SharePoint with rich metadata and formatting. | `SHARE_POINT_RENDER_LIST_DATA_AS_STREAM` |
| **Queries** | Search query | Search SharePoint content using Keyword Query Language (KQL). | `SHARE_POINT_SEARCH_QUERY` |
| **Roles and permissions** | Get role definitions | List role definitions at the web level. | `SHARE_POINT_GET_ROLE_DEFINITIONS` |
| | Get user effective permissions on web | Get a user's effective permissions on the current SharePoint site (Web). | `SHARE_POINT_GET_USER_EFFECTIVE_PERMISSIONS_ON_WEB` |
| **Sites** | List sites | Retrieve all SharePoint sites accessible to the user. | `SHARE_POINT_LIST_SITES` |
| **Users** | Get current user | Retrieve the current user for the site. | `SHARE_POINT_GET_CURRENT_USER` |
| | List site users | List users in the site collection. | `SHARE_POINT_LIST_SITE_USERS` |
| **Other actions** | Get context info | Retrieve SharePoint context information including the form digest value. | `SHARE_POINT_GET_CONTEXT_INFO` |
| | Get my followed | Get entities the current user is following. | `SHARE_POINT_GET_MY_FOLLOWED` |
| | Is followed | Check if the current user is following a specified actor. | `SHARE_POINT_IS_FOLLOWED` |
Agents can use 96 of the 105 SharePoint actions at this level: everything in **Read-only**, plus:
* Create and update list items
* View, create, and update types
* Search, create, update, and manage files
* Search, create, and manage users
* View change history
* Create and update fields
* Create and update folders
* Create and update lists
* View subscriptions
* View and update versions
* View collections
* View columns
The 69 actions that this level adds to **Read-only**:
| Action | What it does | Slug |
| --------------------------- | -------------------------------------------- | ----------------------------------------- |
| Add attachment to list item | Add an attachment to a SharePoint list item. | `SHARE_POINT_ADD_ATTACHMENT_TO_LIST_ITEM` |
| Action | What it does | Slug |
| ---------------------- | ------------------------------------------------- | ------------------------------------ |
| Get changes | Retrieve changes from SharePoint list change log. | `SHARE_POINT_GET_CHANGES` |
| Get drive item changes | | `SHARE_POINT_GET_DRIVE_ITEM_CHANGES` |
| Action | What it does | Slug |
| ------------------------ | ------------------------------------------------------------ | -------------------------------------- |
| Get site collection info | Fetch site collection metadata (URL, ID, root web URI) only. | `SHARE_POINT_GET_SITE_COLLECTION_INFO` |
| Action | What it does | Slug |
| ----------------- | ------------------------------------------------- | ------------------------------- |
| List list columns | List all column definitions in a SharePoint list. | `SHARE_POINT_LIST_LIST_COLUMNS` |
| Action | What it does | Slug |
| --------------- | ------------ | ----------------------------- |
| Get drive by ID | | `SHARE_POINT_GET_DRIVE_BY_ID` |
| Action | What it does | Slug |
| --------- | ----------------------------------------------------------------------------- | ----------------------- |
| Log event | Log custom usage analytics events in SharePoint for tracking user activities. | `SHARE_POINT_LOG_EVENT` |
| Action | What it does | Slug |
| ----------------- | ------------------------------------------------- | ------------------------------- |
| Create list field | Create a new field (column) in a SharePoint list. | `SHARE_POINT_CREATE_LIST_FIELD` |
| Update list field | | `SHARE_POINT_UPDATE_LIST_FIELD` |
| Action | What it does | Slug |
| ------------------------------- | -------------------------------------------------------------------- | --------------------------------------------- |
| Check in file | Check in a file. | `SHARE_POINT_CHECK_IN_FILE` |
| Get file by server relative URL | DEPRECATED: Use GetSiteDriveItemByPath instead. | `SHARE_POINT_GET_FILE_BY_SERVER_RELATIVE_URL` |
| Recycle file | Move a file to the Recycle Bin. | `SHARE_POINT_RECYCLE_FILE` |
| Search files | | `SHARE_POINT_SEARCH_FILES` |
| SharePoint check out file | Check out a file in a document library. | `SHARE_POINT_SHAREPOINT_CHECK_OUT_FILE` |
| Undo checkout file | Undo a file checkout, discarding any changes made while checked out. | `SHARE_POINT_UNDO_CHECKOUT_FILE` |
| Upload file | Upload a file to a SharePoint document library or folder. | `SHARE_POINT_UPLOAD_FILE` |
| Action | What it does | Slug |
| --------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------- |
| Get folder by server relative URL | DEPRECATED: Use SHARE\_POINT\_GET\_SITE\_DRIVE\_ITEM\_BY\_PATH instead. | `SHARE_POINT_GET_FOLDER_BY_SERVER_RELATIVE_URL` |
| Rename folder | Renames a SharePoint folder by updating its list item metadata. | `SHARE_POINT_RENAME_FOLDER` |
| SharePoint create folder | Creates a new folder in SharePoint using the REST API. | `SHARE_POINT_SHAREPOINT_CREATE_FOLDER` |
| Action | What it does | Slug |
| ------------------------------ | ----------------------------------------------------------------- | -------------------------------------------- |
| Add field link to content type | Add a field link to a list content type. | `SHARE_POINT_ADD_FIELD_LINK_TO_CONTENT_TYPE` |
| Create drive item sharing link | Create a sharing link for a drive item in SharePoint or OneDrive. | `SHARE_POINT_CREATE_DRIVE_ITEM_SHARING_LINK` |
| Action | What it does | Slug |
| --------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------- |
| Copy drive item | | `SHARE_POINT_COPY_DRIVE_ITEM` |
| Create list item by ID | Create a new item in a SharePoint list using the list's GUID. | `SHARE_POINT_CREATE_LIST_ITEM_BY_ID` |
| Create list item in folder | Create a list item in a specific folder within a SharePoint list. | `SHARE_POINT_CREATE_LIST_ITEM_IN_FOLDER` |
| Get drive item by ID | | `SHARE_POINT_GET_DRIVE_ITEM_BY_ID` |
| Get list item by ID | Retrieve a SharePoint list item by ID. | `SHARE_POINT_GET_LIST_ITEM_BY_ID` |
| Get site drive item by path | Retrieve a file or folder by its server-relative path in a SharePoint site. | `SHARE_POINT_GET_SITE_DRIVE_ITEM_BY_PATH` |
| Recycle list item | Move a list item to the Recycle Bin. | `SHARE_POINT_RECYCLE_LIST_ITEM` |
| Restore recycle bin item | Restore a SharePoint Recycle Bin item. | `SHARE_POINT_RESTORE_RECYCLE_BIN_ITEM` |
| SharePoint create list item | Creates a new item in a SharePoint list. | `SHARE_POINT_SHAREPOINT_CREATE_LIST_ITEM` |
| Update drive item | Update the properties of a drive item (file or folder) in SharePoint using SharePoint REST API. | `SHARE_POINT_UPDATE_DRIVE_ITEM` |
| Update file item | | `SHARE_POINT_UPDATE_FILE_ITEM` |
| Update list item | Update fields on an existing SharePoint list item. | `SHARE_POINT_UPDATE_LIST_ITEM` |
| Action | What it does | Slug |
| ---------------------- | ---------------------------------------------------- | ------------------------------------ |
| Get list by guid | Retrieve a SharePoint list by its GUID. | `SHARE_POINT_GET_LIST_BY_GUID` |
| Get list by title | Retrieve a SharePoint list by its title. | `SHARE_POINT_GET_LIST_BY_TITLE` |
| SharePoint create list | Creates a new list in SharePoint using the REST API. | `SHARE_POINT_SHAREPOINT_CREATE_LIST` |
| Update list | Update properties of an existing SharePoint list. | `SHARE_POINT_UPDATE_LIST` |
| Action | What it does | Slug |
| ------------------------ | ------------------------------------------ | -------------------------------------- |
| Get drive item analytics | Get analytics for a SharePoint drive item. | `SHARE_POINT_GET_DRIVE_ITEM_ANALYTICS` |
| Action | What it does | Slug |
| ------------------------------ | ------------------------------------------------------------------------------------------- | -------------------------------------------- |
| Add role assignment to item | Add a role assignment to a list item. | `SHARE_POINT_ADD_ROLE_ASSIGNMENT_TO_ITEM` |
| Add role assignment to list | Add a role assignment to a SharePoint list. | `SHARE_POINT_ADD_ROLE_ASSIGNMENT_TO_LIST` |
| Break role inheritance on item | Break permission inheritance on a list item. | `SHARE_POINT_BREAK_ROLE_INHERITANCE_ON_ITEM` |
| Break role inheritance on list | Breaks permission inheritance on a SharePoint list, allowing you to set unique permissions. | `SHARE_POINT_BREAK_ROLE_INHERITANCE_ON_LIST` |
| List drive item permissions | | `SHARE_POINT_LIST_DRIVE_ITEM_PERMISSIONS` |
| List web role assignments | | `SHARE_POINT_LIST_WEB_ROLE_ASSIGNMENTS` |
| Action | What it does | Slug |
| -------------------- | ------------------------------------------------------- | ---------------------------------- |
| Get site by hostname | | `SHARE_POINT_GET_SITE_BY_HOSTNAME` |
| Get site by ID | | `SHARE_POINT_GET_SITE_BY_ID` |
| Get site root | | `SHARE_POINT_GET_SITE_ROOT` |
| Update site | Update properties of the current SharePoint site (web). | `SHARE_POINT_UPDATE_SITE` |
| Action | What it does | Slug |
| ------------------------- | ---------------------------------------------------------------------- | --------------------------------------- |
| Get webhook subscription | Retrieve a specific webhook subscription by ID from a SharePoint list. | `SHARE_POINT_GET_WEBHOOK_SUBSCRIPTION` |
| Get webhook subscriptions | Retrieve all webhook subscriptions on a SharePoint list. | `SHARE_POINT_GET_WEBHOOK_SUBSCRIPTIONS` |
| Action | What it does | Slug |
| --------------------------- | ------------------------------------------------------------------------------------------------- | ----------------------------------------- |
| Create content type | Create a new content type in SharePoint. | `SHARE_POINT_CREATE_CONTENT_TYPE` |
| Get content type | Retrieve a single SharePoint content type by its ID. | `SHARE_POINT_GET_CONTENT_TYPE` |
| Get content types | Retrieves all content types from the current SharePoint site. | `SHARE_POINT_GET_CONTENT_TYPES` |
| Get content types for list | Retrieve all content types for a specific SharePoint list by GUID. | `SHARE_POINT_GET_CONTENT_TYPES_FOR_LIST` |
| Get list content type by ID | Retrieve a specific content type from a SharePoint list by its ID. | `SHARE_POINT_GET_LIST_CONTENT_TYPE_BY_ID` |
| Update content type | Update a SharePoint content type's properties such as name, description, group, or hidden status. | `SHARE_POINT_UPDATE_CONTENT_TYPE` |
| Action | What it does | Slug |
| ---------------------- | ----------------------------------------------------------------------------------------------------------- | ------------------------------------ |
| Ensure user | Ensures a user exists in a SharePoint site by their login name. | `SHARE_POINT_ENSURE_USER` |
| Get group users | Retrieves all users who are members of a specified SharePoint group. | `SHARE_POINT_GET_GROUP_USERS` |
| Get group users by ID | Retrieve all users in a specific SharePoint site group by group ID. | `SHARE_POINT_GET_GROUP_USERS_BY_ID` |
| SharePoint create user | DEPRECATED: Use SHARE\_POINT\_ENSURE\_USER instead (supports email param directly). | `SHARE_POINT_SHAREPOINT_CREATE_USER` |
| SharePoint find user | Searches for a user in the SharePoint site by email address and returns their profile information if found. | `SHARE_POINT_SHAREPOINT_FIND_USER` |
| Action | What it does | Slug |
| -------------------------- | ------------------------------------------------------ | ---------------------------------------- |
| Get list item version | Retrieve a specific version of a SharePoint list item. | `SHARE_POINT_GET_LIST_ITEM_VERSION` |
| Restore drive item version | Restore a previous version of a SharePoint drive item. | `SHARE_POINT_RESTORE_DRIVE_ITEM_VERSION` |
| Action | What it does | Slug |
| ------------------- | ---------------------------------------------------------------------------- | --------------------------------- |
| Create web | Create a new SharePoint subsite under the current site. | `SHARE_POINT_CREATE_WEB` |
| Follow | Follow a SharePoint user, document, site, or tag. | `SHARE_POINT_FOLLOW` |
| Get web info | Retrieve information about the current SharePoint web (site) using REST API. | `SHARE_POINT_GET_WEB_INFO` |
| Search suggest | Get search query suggestions. | `SHARE_POINT_SEARCH_SUGGEST` |
| Upload from URL | Fetch a file from a URL and upload it to SharePoint. | `SHARE_POINT_UPLOAD_FROM_URL` |
| Validate credential | | `SHARE_POINT_VALIDATE_CREDENTIAL` |
Agents can use 105 of the 105 SharePoint actions at this level: everything in **Read + write**, plus:
* Delete list items
* Delete lists
* Delete content
* Delete folders
* Delete users
The 9 actions that this level adds to **Read + write**:
| Works on | Action | What it does | Slug |
| -------------- | --------------------------------- | -------------------------------------------------------------------- | ----------------------------------------------- |
| **Content** | Delete drive item version content | Delete content for a specific version of a drive item in SharePoint. | `SHARE_POINT_DELETE_DRIVE_ITEM_VERSION_CONTENT` |
| **Folders** | Delete folder | Deletes a folder from a SharePoint document library. | `SHARE_POINT_DELETE_FOLDER` |
| **List items** | Delete file item | | `SHARE_POINT_DELETE_FILE_ITEM` |
| | Delete list item | Delete a SharePoint list item. | `SHARE_POINT_DELETE_LIST_ITEM` |
| | Delete list items | | `SHARE_POINT_DELETE_LIST_ITEMS` |
| | Delete recycle bin item permanent | Permanently delete a SharePoint Recycle Bin item. | `SHARE_POINT_DELETE_RECYCLE_BIN_ITEM_PERMANENT` |
| **Lists** | Delete list | Delete a SharePoint list. | `SHARE_POINT_DELETE_LIST` |
| | Delete list by title | Delete a SharePoint list by its title. | `SHARE_POINT_DELETE_LIST_BY_TITLE` |
| **Users** | SharePoint remove user | Removes a user from SharePoint. | `SHARE_POINT_SHAREPOINT_REMOVE_USER` |
## Connect SharePoint
Before you start:
* You need a SharePoint account that you can sign in to.
* Your Squad subscription must be active. Squad does not connect apps while the subscription is not active.
Open **Settings** > **Integrations**.
On the **Connected apps** tab, click **+ Add integration**.
Find **SharePoint** in the catalog and click it. You can type the name in **Search the catalog…**.
Under **Default scope**, choose an access level. This level applies to every agent.
Click **Connect SharePoint**. The SharePoint sign-in page opens in a new tab.
Sign in to SharePoint and approve the request.
Check that it works: SharePoint shows under **YOUR CONNECTIONS**, with a row for the account and its access level.
## Change the access level
1. Under **YOUR CONNECTIONS**, find the SharePoint account.
2. Open the account menu (⋯) and click **Manage scope**.
3. Under **Default scope**, choose the new level.
4. Click **Save access**.
The change does not need a new sign-in. Agents get the new level from their next call.
## Set access for one agent
Every agent uses the account's level unless you set something else for it. You can narrow one agent to a lower level, or block it.
1. Under **YOUR CONNECTIONS**, open the account menu (⋯) on the SharePoint account.
2. Click **Manage scope**.
3. Under **Per-agent access**, find the agent.
4. Choose the **Default** option to follow the account's level, choose a lower level, or choose **No access**.
5. Click **Save access**.
An agent never gets more than the account's level, even if you choose a higher level for it. Changes apply from the agent's next call. An agent with **No access** does not see the account.
## Use more than one SharePoint account
Click **+ Account** on the SharePoint card to connect another account. Agents use the primary account unless they are asked to use a specific one.
* After you click **+ Account**, follow the connect steps above.
* Each account has its own access level.
* The first account you connect becomes the primary account. It shows **★ PRIMARY**.
* To change the primary account, open the account menu (⋯) and click **Make primary**.
* To tell accounts apart, open the account menu (⋯) and click **Rename**.
## Reconnect or disconnect
Reconnect when the connection has expired, or when you need to change what the account can reach on the SharePoint side:
1. Open the account menu (⋯) and click **Reconnect**.
2. Click **Reauthorize on SharePoint**.
3. Sign in to SharePoint and approve the request.
Reconnect signs in to the same account again. It does not add a second connection.
Open the account menu (⋯) on the SharePoint account and click **Disconnect**. Agents lose access to that account at once.
**Disconnect** acts at once, with no confirmation step. If it was the primary account, another connected SharePoint account becomes primary.
## Costs
SharePoint actions do not use Squad credits. Connected apps never use credits. For what does use credits, see [What Squad costs](/docs/costs).
## Troubleshooting
An agent reports that an action is not allowed on this account.
* Cause: the action is outside the account's access level, or outside the level you set for that agent.
* Fix: choose a higher level in **Manage scope**, or change the agent's row under **Per-agent access**.
An agent says it has no access to SharePoint, or it does not see the account.
* Cause: the agent is set to **No access** under **Per-agent access**, or the account is not connected.
* Fix: open **Manage scope** and change the agent's row. If the account is missing, connect it again.
Connecting or saving fails with "Your subscription isn't active."
* Cause: your Squad subscription is not active.
* Fix: resubscribe. See [Manage your subscription](/docs/billing).
An agent says the SharePoint connection has expired.
* Cause: the sign-in for that account is no longer valid.
* Fix: use **Reconnect** on the account.
## Common questions
Each SharePoint account has an access level: **Read-only**, **Read + write**, and **Full access**. Squad refuses any agent action outside that level. You can also narrow or block single agents under **Per-agent access**.
Click **+ Account** on the SharePoint card to connect another account. Agents use the primary account unless they are asked to use a specific one.
Open the account menu (⋯) on the SharePoint account and click **Disconnect**. Agents lose access to that account at once.
## Related pages
Use this when an action you need is not in this app.