Overview
Using your search parameters (QueryOptions) and specified team list type (Filter - AllTeams or MyJoinedTeams), the Get Teams activity calls the Microsoft Graph ListAllTeams or ListJoinedTeams APIs to retrieve the teams that match your query .
After retrieving the teams, the activity outputs their properties and relationships in Team[]
object that you can use as input variables in subsequent activities (e.g., `Team(0).Id in Get Channels, Update Channel, etc.).
How it works
The following steps and message sequence diagram is an example how the activity works from design time (i.e., the activity dependencies and input/output properties) to run time.
- Complete the Setup steps.
- Add the Microsoft Teams Scope activity to your project.
- Add the Get Teams activity inside the Microsoft Teams Scope activity.
- Enter values for the Input properties.
- Create and enter a
Team[]
variable for your Output property. - Run the activity.
- Your input property values are sent to the ListAllTeams or ListJoinedTeams APIs.
- The API returns the
Team[]
value to your output property variable.


Properties
The values for the following properties are specified when adding this activity to your project in UiPath Studio.


Common
DisplayName
The display name of the activity.
Attributes | Details |
---|---|
Type |
|
Required | Yes |
Default value | Get Teams |
Allowed values | Enter a |
Notes | N/A |
Input
Filter
The type of teams that you want to retrieve.
Attributes | Details |
---|---|
Type | Drop-down list |
Required | Yes |
Default value | AllTeams |
Allowed values | Select from two options: |
Notes | The example sequence image below shows the output of both options. |
Options
QueryOptions
The search parameters that you want to apply when retrieving your list of teams.
Attributes | Details |
---|---|
Type |
|
Required | No |
Default value | Empty |
Allowed values | Enter a |
Notes | Enter your value using an OData system query option; the format is as follows: {New QueryOption("Option", "OptionParameter")}. |
Misc
Private
If selected, the values of variables and arguments are no longer logged at Verbose level.
Attributes | Details |
---|---|
Type | Checkbox |
Required | No |
Default value | Not Selected |
Allowed values | Selected or Not Selected |
Notes | N/A |
Output
Teams
An array of teams (Team[]
object) that match your ListType and QueryOptions values.
Attributes | Details |
---|---|
Type |
|
Required | No (required if you plan to use the output data in subsequent activities) |
Default value | Empty |
Allowed values | Enter a |
Notes | The variable you create for this property can be used as an input variable in subsequent activities (e.g., `Team(0).Id in Get Channels, Update Channel, etc.).
|
Example
The following image shows an example of the activity dependency relationship and input/output property values.
For step-by-step instructions and examples, see the Quickstart guides.


Option 1 - MyJoinedTeams


Option 2 - AllTeams
Updated about a year ago