List Channel Members

List the channel members of a Microsoft Teams.

Options

Field Definition Type Required
Result Set Choose one of the following options to display your search results:
  • First 200 Records - returns the first 200 matching members.
  • Stream Records - pass all matching records from your parent flow to a helper flow; a Streaming input section will be added to the card from which you can select a helper flow for streaming and adding custom extensible fields.
 Dropdown TRUE
Note

To learn how to use the Stream Records option and set up a helper flow to return a large number of records, see Set up the stream matching option with a helper flow.

Input

Field Definition Type Required
Team
ID Unique ID of the Team. String TRUE
Channel
ID Unique ID of the Channel. String TRUE
List Criteria
Record Limit

Specify the number of records to stream.

  • When the Limit field is set to 0, no records are returned.

  • When the Limit field is set to greater than 0, records greater than 0 and up the maximum number of records specified are returned.

  • When the Limit field is empty or not selected, all records are streamed.

  • Default value is 10 million.

  • Valid range is 0 to 10 million.

Appears when Stream Records is selected from the Result Set option.

 Number FALSE
Streaming
Flow

Click Choose Flow to browse and select a helper flow where the search results will be streamed, then click Choose to confirm.

Optionally, click the empty field under Click or drop here to create and add custom extensible fields that pass data to the helper flow. These fields are added as key/value pairs under the State output object in the helper flow.

Displays when Stream Records is selected from the Result Set field.

 Flow TRUE

Output

Field Definition Type
Records Streamed Number of records returned.

This field display when Stream Records is selected from the Result Set field.

 Number
Channel Members Display when First 200 Records is selected from the Result Set field. List of Objects
Raw Output Raw payload returned from the Microsoft Teams API. Object
ID Unique ID of the member. String
Roles Role of the user in the team. List of Text
Display Name Display name for the team. String
Visible History Start Date Time Timestamp denoting how far back a conversation's history is shared with the conversation members. Date and Time
User ID Unique identifier of the user. String
Email Email address for sending messages to the channel. String

Related topics

Microsoft Teams connector

Elements of Workflows

Guidance for Microsoft Teams connector

Microsoft Teams API overview