GET
/inboxes/{inbox_id}/threadsList threads in an inbox
Lists threads in an inbox, ordered by most recent activity first. Use folders, labels, or read to filter the results, and use after or before to navigate by thread ID; you can pass only one cursor at a time.
inbox_idstringrequired
The UUID of the inbox whose threads you want to list. An email address is not accepted.
foldersarray<string>optional
Comma-separated folders to include: `inbox`, `archive`, `spam`, `sent`, or `trash`. Defaults to `inbox`, or to `inbox,archive,sent` when `labels` is set; `spam` and `trash` are included only when named. A thread is included when any of its emails is in a selected folder.
labelsarray<string>optional
Comma-separated label UUIDs; returns threads with any of the specified labels. Accepts up to 50 IDs.
readbooleanoptional
Set to `true` for threads where every email is read, or `false` for threads with at least one unread email.
limitintegeroptional
Number of threads to return. Must be between 1 and 100.
afterstringoptional
Thread ID cursor; returns threads after this cursor. Use a UUID and do not pass it with `before`.
beforestringoptional
Thread ID cursor; returns threads before this cursor. Use a UUID and do not pass it with `after`.
200Returns an object with a `data` array of matching threads ordered by most recent activity first, and a `has_more` value indicating whether additional results are available.
objectstringrequired
Type of the response object.
has_morebooleanrequired
Indicates if there are more results available.
dataarray<object>required
The matching threads, most recently active first.
Error handling
The inbox_id path parameter must be a UUID for an inbox; an email address is not accepted. folders must use the listed folder values, read accepts only true or false, limit must be between 1 and 100, and labels accepts at most 50 UUIDs. Use only one of after and before; its value must be a thread ID in UUID format, and the cursor thread must be in the selected folders.