InboxList conversations

List conversations

Most recently active first. One thread per conversation per mailbox, including sends that have not been answered yet only once they are part of a threaded exchange.

curl -X GET "https://api.supasend.io/v1/inbox/threads?mailbox_id=example_string&unread=true&participant=example_string&since=2024-12-25T10%3A00%3A00Z&fresh=false&limit=50&offset=0" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY"
{
  "threads": [
    {
      "id": "example_string",
      "mailbox_id": "example_string",
      "root_message_id": "example_string",
      "subject": "example_string",
      "participants": [
        "example_string"
      ],
      "email_job_id": "user@example.com",
      "message_count": 25,
      "unread_count": 10,
      "last_message_at": "2024-12-25T10:00:00Z",
      "last_message_direction": "inbound",
      "last_inbound_at": "2024-12-25T10:00:00Z",
      "snippet": "example_string",
      "created_at": "2024-12-25T10:00:00Z",
      "updated_at": "2024-12-25T10:00:00Z"
    }
  ],
  "limit": 42,
  "offset": 42,
  "sync": [
    {
      "mailbox_id": "example_string",
      "stored": 42,
      "remaining": 42,
      "error": "example_string",
      "skipped": "example_string"
    }
  ]
}
GET
/v1/inbox/threads
GET
Base URLstring

Target server for requests. Edit to use your own host.

API Key (header: X-API-Key)
X-API-Keystring
Required

API key in the format sk_live_<64 hex characters>

API key in the format sk_live_<64 hex characters>
query
unreadboolean

true = threads with unread inbound messages

query
participantstring

Counterparty email address

query
sincestring
Format: date-time
query
freshboolean

Pull new mail from the provider (Google / Outlook / IMAP) before answering, so one call does "fetch from the mailbox and show me". Bounded to ~10 seconds; the response's sync array reports what happened per mailbox. Without it, results reflect the last scheduled pull (every 2 minutes by default).

Request Preview
Response

Response will appear here after sending the request

Authentication

header
X-API-Keystring
Required

API Key for authentication. API key in the format sk_live_\<64 hex characters\>

Query Parameters

unreadboolean

true = threads with unread inbound messages

participantstring

Counterparty email address

freshboolean

Pull new mail from the provider (Google / Outlook / IMAP) before answering, so one call does "fetch from the mailbox and show me". Bounded to ~10 seconds; the response's sync array reports what happened per mailbox. Without it, results reflect the last scheduled pull (every 2 minutes by default).

Responses

threadsarray
limitinteger
offsetinteger
syncarray

Present only when fresh=true was passed — one entry per mailbox considered