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

To learn how to return large numbers of records, see Stream matching records with a helper flow.

Input

Field Definition Type Required

Team

Id Unique identifier of the Team.

Text

TRUE

Channel

Id Unique identifier of the Channel.

Text

TRUE

List Criteria

Record Limit

Specify the number of records to stream.

  • When the Record Limit field is set to 0, the card returns a 400 Bad Request error.

  • When the Record Limit field is set to greater than 0, the stream returns up to the maximum number specified.

  • When the Record Limit field is empty, null, or not selected, the stream returns all records.

  • The default value is 4900000 (4.9 million).

  • The valid range is 1 to 4900000.

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.

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

Flow

TRUE

Output

Field Definition Type
Records Streamed Number of records returned.

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

Number
Channel Members This field appears 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 identifier of the member.

Text
Roles Role of the user in the team.

List of Text
Display Name The display name of the team.

Text
Visible History Start Date Time A timestamp denoting how far back a conversation's history is shared with the conversation members.

Date & Time
User Id

Unique identifier of the user.

Text
Email Email address for sending messages to the channel. String

Related topics

Microsoft Teams connector

Workflow elements

Guidance for Microsoft Teams connector

Microsoft Teams API overview