Mailboxes

List threads in a mailbox

Returns thread summaries, most recent activity first.

GET
/v1/mailboxes/{id}/threads

Returns thread summaries, most recent activity first. after and before filter by last activity, so an agent polling for new mail passes the last time it looked. q is a full-text search over subjects, senders, and message text; folder, label, unread, and starred narrow the list. Pass nextCursor back as cursor for the next page; it is null on the last page. A thread that gains activity while you page moves ahead of the cursor, so a walk lists each thread at most once.

x-api-key<token>

In: header

Path Parameters

id*string
Match^mbx_[0-9a-hjkmnp-tv-z]{16,24}$

Query Parameters

limit?string|null
cursor?CursorEncoded|null
after?string|null
before?string|null
q?string|null
folder?|null
label?|null
unread?|null
starred?|null
snoozed?|null

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/mailboxes/string/threads"
{  "items": [    {      "id": "string",      "subject": "string",      "preview": "string",      "from": {        "address": "string",        "displayName": "string"      },      "messageCount": 0,      "hasAttachments": true,      "hasDraft": true,      "folder": "inbox",      "priority": "low",      "labels": [        "string"      ],      "read": true,      "starred": true,      "snoozedUntil": "string",      "lastActivityAt": "string"    }  ],  "nextCursor": "string"}

Related documentation