Docs / Messages

list_conversations

List the conversations in the stored copy of your inbox, across your accounts.

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

What you give it

InputWhat it isWhere to get it
search
optional
Text. Search by participant, headline, message, or connection label.You write it.
unreadOnly
optional
True or false. Only return unread conversations.You write it.
includeThreads
optional
True or false. Attach the full message history (oldest→newest) to each conversation row under `thread`, resolved server-side — not just the latest message. Use this to read a specific conversation by searching the lead name.You write it.
limit
optional
A number, 1 to 200. Max conversations to return (default 50, max 200).You write it.
page
optional
A number. Page number (default 1).You write it.

Call it

curl -X POST https://api.heyreagent.com/v1/actions/list_conversations \
  -H "Authorization: Bearer YOUR_KEY" \
  -H "content-type: application/json" \
  -d '{}'
The same call in JavaScript
const response = await fetch("https://api.heyreagent.com/v1/actions/list_conversations", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_KEY",
    "content-type": "application/json",
  },
  body: JSON.stringify({}),
});
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_conversations",
    headers={"Authorization": "Bearer YOUR_KEY"},
    json={},
)
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_conversations
Send HeadersOn. Name Authorization, Value Bearer YOUR_KEY
Send BodyOn. Body Content Type JSON, Specify Body Using JSON, then paste the body below
{}

Put your own key where it says YOUR_KEY. New here? Start with your first call.

What you get back

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

total
page
limit
totalPages
hasMore
lastFetchedAt
syncInProgress
inbox

A field that does not apply to an answer is left out, or is null.

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_conversations, and the same inputs.