Try ShortPoint nowWe have prepared a list of use cases for the Microsoft Graph API Connection that you can select during the connection setup process.
The Graph API connection currently supports over 90 use cases. This article covers the most common ones to help you get connected more easily. We regularly add new use cases based on customer feedback and the scenarios we see being used most frequently.
TABLE OF CONTENTS
Before we begin
This article covers the supported use cases for the Microsoft Graph API connection type. For help in enabling and setting up the connection, see our support documentation in Microsoft Graph API Resources and Common Use Cases. To learn how to apply these use cases, check out our article on Getting Started With Microsoft Graph API Use Cases.
Supported request and permission type
The ShortPoint Microsoft Graph API connection only supports GET requests with Delegated permissions. It does not support other request or permission types.
List of supported use cases
The following table lists the most common use cases supported by the ShortPoint Microsoft Graph API connection, organized by category. It includes the required API access permissions for retrieving results and the additional parameters needed for running successful queries.
Groups
Use Case Name | Required API Access permissions | Description | Use Case Parameters |
Directory.Read.All Group.Read.All | Retrieves a list of groups (alphabetical order) in the signed-in user's organization. | None | |
Files.Read.All Sites.Read.All | Get the items within a specific folder in a group's drive. | Drive ID Drive Item ID | |
Drive Items in a Group’s Drive | Files.Read.All Sites.Read.All | Gets all the items in a group's drive. | Group ID |
Group Details | Directory.Read.All Group.Read.All | Retrieves information about an identified group ID. | Group ID |
Group’s Drives | Files.Read.All Sites.Read.All | Retrieves a list of existing drives from a specified group ID. | Group ID |
Group’s Team Site | Sites.Read.All | Retrieves the properties and relationships of the root site of a specified group ID. | Group ID |
| Directory.Read.All | Retrieves a list of groups that the signed in user is a member of. | None | |
| Groups User Belongs To | Directory.Read.All | Retrieves a list of groups where the user is a member of. Check this article to learn more about this use case. | Email Address |
List a Group’s Conversations | Group.Read.All | Retrieves the list of conversations in a selected team/group | Group ID |
Group.Read.All Calendars.Read | Retrieves a list of events from the default calendar of a specified group. | Group ID Start Date End Date | |
Directory.Read.All Group.Read.All | Retrieves a list of a group's direct members. A group can have users, organizational contacts, devices, service principals and other groups as members. | Group ID |
One Drive
Use Case Name | Required API Access permissions | Description | Use Case Parameters |
Files.Read.All Sites.Read.All | Retrieves all items in the signed-in user's Drive. | None | |
All Items in User’s Root Drive | Files.Read.All Sites.Read.All | Retrieve items from a specific user's Drive. | Email Address |
Children in a Drive Item (Folder) | Files.Read Files.Read.All Sites.Read.All | Retrieves drive files and folders from a specified parent folder. The users will see only items they have permission to see. | Drive ID Drive Item ID |
My Drives | Files.Read.All Sites.Read.All | Retrieve the signed-in user's available drives. | None |
Files.Read.All Sites.Read.All | Lists a set of items recently used by the signed-in user. This will show items that are in the user's drive as well as items they have access to from other drives. | None | |
Search My OneDrive | Files.Read.All Sites.Read.All | Searches the signed-in user's drive for items matching a query. | Search Text |
Search User’s OneDrive | Files.Read.All Sites.Read.All | Searches a specified user's drive for items matching a query. | Email Search Text |
User’s Drives | Files.Read.All Sites.Read.All | Retrieves a specified user's available drives. | Email Address |
User’s Recent OneDrive Items | Files.Read.All Sites.Read.All | Lists a set of items recently used by a specified user. This will show items that are in the user's drive as well as items they have access to from other drives. | Email Address |
Items
Use Case Name | Required API Access permissions | Description | Use Case Parameters |
| Sites.Read.All | Lists a set of items recently viewed or modified by the signed-in user. This will show items that are in the user's drives, items they have access to from other drives, and visited site pages. | None | |
Files.Read.All Sites.Read.All | List the current user's recently visited documents. This collection includes document types specified in the use case parameter. | None | |
All Items Viewed or Modified by User | Sites.Read.All | Lists a set of items recently viewed or modified by a specified user. This will show items that are in the user's drives, items they have access to from other drives, and visited site pages. | Email Address |
Items Shared With Me | Files.Read.All Sites.Read.All | Lists a set of items that have been shared with the signed-in user, including items from SharePoint Libraries. | None |
Items Shared With User | Files.Read.All Sites.Read.All | Lists a set of items that have been shared with a specified user, including items from SharePoint Libraries. | Email Address |
Items Trending Around Me | Sites.Read.All | Retrieves a list of documents trending around the signed-in user. | None |
Items Trending Around User | Sites.Read.All | Retrieves a list of documents trending around a specified user. | Email Address |
Users
Use Case Name | Required API Access permissions | Description | Use Case Parameters |
User.Read.All Directory.Read.All | Lists all of the users in the organization. | None | |
User.Read.All Directory.Read.All | Lists users belonging to a specific department. | Department | |
My Calendars | Calendars.Read | Gets all of the signed-in user's calendars. | None |
My Contacts | Contacts.Read | Gets the collection of contacts from the default contacts folder of the signed-in user. | None |
My Direct Reports | User.Read.All Directory.Read.All | Lists the direct reports of the signed-in user. | None |
My User Profile | User.Read.All Directory.Read.All | Retrieves the signed-in user's properties. | None |
People a User Works With | People.Read.All | Retrieves a collection of person objects ordered by their relevance to a specified user, which is determined by the user's communication and collaboration patterns, and business relationships. | Email Address |
| People.Read.All | Retrieves a collection of person objects ordered by their relevance to the signed-in user, which is determined by the user's communication and collaboration patterns, and business relationships. | None | |
| Search People by Name | People.Read.All | Finds people relevant to the signed-in user, filtered using a search query. By default the query returns 10 items maximum. Please use the items limit to increase the number of results. | Search Text |
User’s Calendars | Calendars.Read | Gets all of a specified user's calendars. | Email Address |
User’s Contacts | Contacts.Read | Gets all contacts from the default contacts folder of a specified user. | Email Address |
User’s Direct Reports | User.Read.All Directory.Read.All | Lists the direct reports of a specified user. | Email Address |
User’s Profile | User.Read.All Directory.Read.All | Retrieves specified user's profile properties. | Email Address |
Teams
Use Case Name | Required API Access permissions | Description | Use Case Parameters |
Channel Info | Directory.Read.All Group.Read.All | Retrieves the properties and relationships of a specified channel. The signed-in user must be a member of this channel. | Team ID Channel ID |
Directory.Read.All Group.Read.All | Retrieves the list of channels in a specified team. The signed-in user must be a member of these channels. | Team ID | |
| ChannelMessage. Read.All | Retrieve all messages in a channel. The signed-in user must be a member of the team and have access to this channel. | Team ID Channel ID | |
User.Read.All Directory.Read.All | Retrieves the list of Teams the signed-in user has joined. | None | |
Directory.Read.All Group.Read.All | Retrieves the list of tabs in a specified channel. The signed-in user must be a member of this channel. | Team ID Channel ID | |
Teams from Organization | Directory.Read.All Group.Read.All | Retrieves the list of Teams from your Organization. | None |
User’s Teams | User.Read.All Directory.Read.All | Retrieves the list of Teams a specified user has joined. | Email Address |
Excel
Use Case Name | Required API Access permissions | Description | Use Case Parameters |
Chart Image in Worksheet | Files.Read | Retrieves a list of chart objects in a worksheet. | File ID Worksheet Name Chart ID Width Height |
Charts in Worksheet | Files.Read | Retrieves a list of chart objects in a worksheet. | File ID Worksheet Name |
| Files.Read | Retrieves a list of rows from a worksheet table. | File ID Table ID | |
Tables in Workbook | Files.Read | Retrieves a list of table objects in the entire Workbook (all sheets). | File ID |
Tables in Worksheet | Files.Read | Retrieves a list of table objects in a worksheet. | File ID Worksheet Name |
Worksheets in a Workbook | Files.Read | Retrieves a list of worksheet objects in a workbook. | File ID |
SharePoint
Use Case Name | Required API Access permissions | Description | Use Case Parameters |
Sites.Read.All | Retrieves a list of SharePoint Document Libraries from a specified site. | Site ID | |
Lists in a SharePoint Site | Sites.Read.All | Retrieves a list of SharePoint Lists from the selected site. | Site ID |
Lists in the default SharePoint Site | Sites.Read.All | Retrieves all lists in the root site. | None |
Sites.Read.All | Retrieves a list of all SharePoint sites the signed-in user has followed. | None | |
My Organization’s Default SharePoint Site | Sites.Read.All | Retrieves the properties and relationships for a site resource. A site resource represents a SharePoint team site. | None |
Search for a SharePoint Site by Keyword | Sites.Read.All | Searches across a SharePoint tenant for sites matching the keyword provided. | Keyword |
SharePoint Site Based in Relative Path | Sites.Read.All | Gets a SharePoint site's properties based on its relative path. | Host Name Relative Path |
SharePoint Sites available in the tenant | Sites.Read.All | Gets a list of sites available in your tenant. This collection will include my-sites. | None |
Sites.Read.All | Retrieves a list of SharePoint subsites based on a specified site ID. | Site ID | |
| Subsites of the Default SharePoint Site | Sites.Read.All | Get the collection of subsites under the root site. | None |
User’s Followed SharePoint Sites | Sites.Read.All | Retrieves a list of all SharePoint sites a specified user has followed. | Email Address |
Emails
Use Case Name | Required API Access permissions | Description | Use Case Parameters |
Filter My Emails for a Search Term | Mail.Read | Gets all messages in the signed-in user's mailbox matching a search query (including the Deleted Items and Clutter folders). | Search Text |
Filter User’s Emails for a Search Term | Mail.Read | Gets all messages in a specified user's mailbox matching a search query (including the Deleted Items and Clutter folders). | User's Email Address Search Text |
Mail.Read | Retrieves the signed-in user's emails. | None | |
My Emails by Sender | Mail.Read | Retrieves all messages in the signed-in user's mailbox (including the Deleted Items and Clutter folders), filtered by a sender's email address. | Sender's Email Address |
Mail.Read | Gets the messages in the signed-in user's mailbox (including the Deleted Items and Clutter folders), where the importance property is set to 'high'. | None | |
User’s Emails | Mail.Read | Retrieves a specified user's emails without filters. | Email Address |
User’s Emails by Sender | Mail.Read | Retrieves the messages in the specified user's mailbox (including the Deleted Items and Clutter folders), filtered by a sender's email address. | User's Mailbox Sender's Email Address |
User’s Highly Important Emails | Mail.Read | Gets the messages in a specified user's mailbox (including the Deleted Items and Clutter folders), where the importance property is set to 'high'. | User's Email Address |
Events
Use Case Name | Required API Access permissions | Description | Use Case Parameters |
Calendars.Read | Retrieves the signed-in user's calendar events from a selected period. | Start Date End Date | |
My Events For the next Week (Root Instance Only) | Calendars.Read | Lists only the root events in the signed-in user's calendar. This use case will not display each occurrence of a recurring event, but only the root one in case that the selected time span includes it. | Start Date End Date |
Calendars.Read | Retrieves the signed-in user's calendar events (specific calendar)from a selected period. | Calendar ID Start Date End Date | |
User’s Events for the next Week | Calendars.Read | Retrieves a specified user's calendar events from a selected period. | Email Address Start Date End Date |
User’s Events for the next Week (Root Instance Only) | Calendars.Read | Lists only the root events in the specified user's calendar. This connection will not display each occurrence of a recurring event, but only the root one in case that the selected time span includes it. | Email Address Start Date End Date |
Calendars.Read | Retrieves the signed-in user's calendar events (specific calendar) from a selected period. | Email Address Calendar ID Start Date End Date |
OneNote
Use Case Name | Required API Access permissions | Description | Use Case Parameters |
My Notebook Page Content | Notes.Read | Gets a signed-in user’s Notebook Page’s contents. Notebook Page ID | Notebook Page ID |
My Notebook Pages | Notes.Read | Lists the signed-in user's OneNote pages. | None |
My Notebook Sections | Notes.Read | Lists the signed-in user's OneNote sections. | None |
My Notebooks | Notes.Read | Lists the signed-in user's OneNote notebooks. | None |
User’s Notebook Page Content | Notes.Read | Gets a specified user’s Notebook Page’s contents. | Email Address Notebook Page ID |
User’s Notebook Pages | Notes.Read | Lists a specified user's OneNote pages. | Email Address |
User’s Notebook Sections | Notes.Read | Lists a specified user's OneNote sections. | Email Address |
User’s Notebooks | Notes.Read | Lists a specified user's OneNote notebooks. | Email Address |
Planner
Use Case Name | Required API Access permissions | Description | Use Case Parameters |
My Planner Plans | Tasks.Read | Lists signed-in user’s Planner plans. | None |
Tasks.Read | Lists signed-in user’s Planner tasks. | None | |
Planner Plans for a Specific Group | Tasks.Read | Lists all the Planner plans for a specified group. | Group ID |
Tasks.Read | Lists all the Planner tasks for a specified plan. | Plan ID |
These are the common use cases you can apply using the ShortPoint Microsoft Graph API connection type. Explore all the items that you can display on your SharePoint page.
Related articles:
