API Reference

Search message groups

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

Search all message groups

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string | null

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

string | null

Search for messages containing an attachment MD5 match

string | null

Search for messages containing an attachment SHA1 match

string | null

Search for messages containing an attachment SHA256 match

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.

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.

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.

string | null

Search in attachment filenames (case insensitive wildcard match)

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.

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.

string | null

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

int32 | null
≤ 500

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

string | null

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

string | null

Search in the Message-ID header (case insensitive exact match; wildcards are not supported)

int32 | null

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

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
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
array of strings

Search for messages by type. Multiple values are OR'd together.

type
Response

Updated 3 months ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 3 months ago