List chat members with the Microsoft Teams API
Lists the people in a chat, with displayName, email and userId.
- Identifier
- microsoft_teams_list_chat_members
The request
POST https://connect.reportei.com/api/tools/microsoft_teams_list_chat_members/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"chat_id": "<chat_id>"
}
}Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| chat_id | string | Yes | Chat id from List chats. |
Supported connections
Your customer connects their Microsoft Teams account once, with one of the modes below. The same connection serves every tool of the toolkit.
OAuth with your product's app
You register your product's OAuth app once, with POST /api/merchants/credentials/microsoft_teams, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.
The response
On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.
Ready for AI agents
This tool's input is a JSON Schema, available at GET /api/tools/microsoft_teams_list_chat_members. It becomes your agent's tool definition with no conversion.
Other Microsoft Teams tools
- List teamsGETLists the teams the user is a direct member of, with id, displayName, description and isArchived. Use the id as team_id in the other tools.
- List channelsGETLists the channels of a team that the user can see, with id, displayName, description, membershipType and webUrl. Private and shared channels appear only to their members. Use the id as channel_id in the message tools.
- Create channelPOSTCreates a standard channel, open to every member of the team, and returns it with its id. Private and shared channels need a member list and are not supported here.
- List channel messagesGETLists the root messages of a channel, without their replies, 20 per page and ordered by the latest activity of each thread. Only the first page comes back: the @odata.nextLink of the response cannot be followed here. Read a thread with List channel message replies.
- Get channel messageGETReturns one root message of a channel, with its body, the sender in from, createdDateTime and webUrl. Its replies are not included.
- List channel message repliesGETLists the replies to a root message of a channel. The root message is not included: read it with Get channel message. Only the first page comes back.
- Send channel messagePOSTPosts a new message in a channel as the user and returns it with its id. Microsoft's terms forbid using Teams as a log, so send only messages that people will read.
- Reply to channel messagePOSTPosts a reply in the thread of a root message of a channel, as the user, and returns it with its id. Send only messages that people will read.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
