Docs / Messages

list_chat_participants

List who is in one conversation.

This action only reads. It changes nothing, so it is safe to try.

What you give it

InputWhat it isWhere to get it
chatId
needed
A chat id. The conversation id (from list_chats).Run list_chats and use chats[].id from its answer.
12 more places to get it
connectionId
optional
A connection id. Which of your LinkedIn accounts to act from (its id from list_linkedin_accounts). Omit to use your first live one.Run list_linkedin_accounts and use accounts[].id from its answer.
15 more places to get it

Call it

curl -X POST https://api.heyreagent.com/v1/actions/list_chat_participants \
  -H "Authorization: Bearer YOUR_KEY" \
  -H "content-type: application/json" \
  -d '{"chatId":"PASTE_CHAT_ID_HERE"}'
The same call in JavaScript
const response = await fetch("https://api.heyreagent.com/v1/actions/list_chat_participants", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_KEY",
    "content-type": "application/json",
  },
  body: JSON.stringify({
    "chatId": "PASTE_CHAT_ID_HERE"
  }),
});
const answer = await response.json();
console.log(answer);
The same call in Python
import requests

response = requests.post(
    "https://api.heyreagent.com/v1/actions/list_chat_participants",
    headers={"Authorization": "Bearer YOUR_KEY"},
    json={
        "chatId": "PASTE_CHAT_ID_HERE",
    },
)
print(response.json())
The same call in n8n

Add an HTTP Request node and fill it in like this:

MethodPOST
URLhttps://api.heyreagent.com/v1/actions/list_chat_participants
Send HeadersOn. Name Authorization, Value Bearer YOUR_KEY
Send BodyOn. Body Content Type JSON, Specify Body Using JSON, then paste the body below
{
  "chatId": "PASTE_CHAT_ID_HERE"
}

Put your own key where it says YOUR_KEY. Put your own value where it says PASTE_…_HERE: the table above says where each one comes from. New here? Start with your first call.

What you get back

When it worked, the answer is { "ok": true, "result": { … } }. Inside result:

returnednumber
nextCursorCursor or null
participants[].idA attendee id. Other actions take it.
participants[].providerIdA member id. Other actions take it.
participants[].namestring
participants[].isSelf1 | 0
participants[].hidden1 | 0
participants[].pictureUrlstring
participants[].profileUrlA profile link. Other actions take it.

A field that does not apply to an answer is left out, or is null. There are 11 more fields nested inside these.

When it did not work, the answer is { "ok": false, "error": "…", "message": "…" }. What each error means.

Good to know

In Claude or ChatGPT

Once connected, ask in your own words. The assistant sees this action as a tool with the same name, list_chat_participants, and the same inputs.