mail

List threads

Scope: read. Pending claim keys allowed. Newest first. Page by passing next_before as before until it is null.

get/v1/threads

Request

  • Base URL: https://botmail.pro
  • URL: https://botmail.pro/v1/threads
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bm_session

Query parameters

mailbox_idstring

Limit to one mailbox. Omit for every mailbox the credential can access.

folder'inbox' | 'sent' | 'archive' | 'starred' | 'spam' | 'trash' | 'held' | 'all'

held = threads with mail held because the account is over its storage quota.

labelstring
unread'1'

1 = only threads with unread messages.

qstring

Full-text search (websearch syntax, e.g. invoice -draft "due date").

fromstring

Comma-separated. Only threads with a message whose sender address or name contains one of these (e.g. github.com). The message filters (q, from, to, has_attachment, since, until) must all match the same message.

tostring

Comma-separated. A to or cc recipient of the message contains one of these.

has_attachment'1'

1 = the message has attachments.

sincestring

Message on or after this time. 2026-10-01, an RFC 3339 time, or an age such as 30m, 12h, 7d, 2w.

untilstring

Message before this time; a YYYY-MM-DD date includes that whole day (UTC).

beforestring date-time

Only threads whose last message is older than this.

limitinteger

Response

Threads.

next_beforestring date-time nullable required

Pass as before for the next page; null when there are no more.

Changes

No recorded changes to this operation across all 1 revision of this API.