Search message groups

get

{scheme}://{server}/v0/message-groups/search

Search all message groups

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

any

string | null

Searches every field (performs a case insensitive, OR search in all fields). Not compatible with other search fields.

attachment_md5

string | null

Search for messages containing an attachment MD5 match

attachment_sha1

string | null

Search for messages containing an attachment SHA1 match

attachment_sha256

string | null

Search for messages containing an attachment SHA256 match

created_at[gte]

date-time | null

Inclusive start datetime filter for search, in UTC using the ISO 8601 format (e.g., '2021-03-14T15:09:26Z'). Only message groups with a message processed at or after this time will be returned.

created_at[lt]

date-time | null

Exclusive end datetime filter for search, in UTC using the ISO 8601 format (e.g., '2021-05-04T15:09:26Z'). Only message groups with a message processed before this time will be returned.

created_at[lte]

date-time | null

Deprecated, use created_at[lt]. Exclusive end datetime filter for search, in UTC using the ISO 8601 format (e.g., '2021-05-04T15:09:26Z'). Only message groups with a message processed before this time will be returned.

file_name

string | null

Search in attachment filenames (case insensitive wildcard match)

first_reported_as_phish_at[gte]

date-time | null

Inclusive start datetime filter for search, in UTC using the ISO 8601 format (e.g., '2021-03-14T15:09:26Z'). Only message groups reported at or after this time will be returned.

first_reported_as_phish_at[lt]

date-time | null

Exclusive end datetime filter for search, in UTC using the ISO 8601 format (e.g., '2021-05-04T15:09:26Z'). Only message groups reported before this time will be returned.

from

string | null

DEPRECATED: Use 'sender' instead. Search in the From field. (case insensitive wildcard match)

limit

int32 | null

≤ 500

The maximum number of message groups to return. If the value exceeds the maximum, then the maximum value will be used.

mailbox

string | null

Search for a mailbox by email address (case insensitive, wildcard match)

message_id

string | null

Search in the Message-ID header (case insensitive wildcard match)

offset

int32 | null

The (zero-based) offset of the message groups to return

sender

string | null

Search in the From field (case insensitive wildcard match)

states

array of strings

Search for messages in any of the given states

states

subject

string | null

Search in the message subject (case insensitive wildcard match)

string | null

Search in the To, CC, and Bcc fields (case insensitive wildcard match). If possible, use 'mailbox' and 'type' instead for better performance

type

string | null

Search for messages by type

Response

200OK