List message groups

get

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

List message groups

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

attachment_name__is

array of strings

Filters result to only message groups with the provided attachment name

attachment_name__is

attachment_sha256__is

array of strings

Filters result to only message groups with the provided attachment SHA256

attachment_sha256__is

attack_score_verdict__is

array of strings

Filters result to only message groups with the provided attack score verdict

attack_score_verdict__is

attack_surface_reduction__filter

string | null

Filters result to only message groups that have flagged (ONLY) rules with the 'Attack surface reduction' tag

canonical_id__is

array of strings

Filters result to only message groups with the provided canonical ID

canonical_id__is

created_at__gte

date-time | null

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

created_at__lt

date-time | null

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

first_message_reported_at[gte]

date-time | null

DEPRECATED: Use first_message_reported_at__gte

first_message_reported_at__gte

date-time | null

Filters result to only message groups with a message first reported at or after the provided time. Datetime must be in UTC using the ISO 8601 format (e.g., '2021-03-14T15:09:26Z').

flagged

boolean | null

Filters result to only message groups with at least one flagged message

flagged_rule_id__is

array of strings

Filters result to only message groups with the provided flagged rule ID

flagged_rule_id__is

flagged_rule_severity__is

array of strings

Filters result to only message groups with the provided flagged rule severity

flagged_rule_severity__is

historically_flagged_rule_id__is

array of strings

Filters result to only message groups with the provided historically flagged rule ID

historically_flagged_rule_id__is

historically_flagged_rule_severity__is

array of strings

Filters result to only message groups with the provided historically flagged rule severity

historically_flagged_rule_severity__is

last_message_created_at[gte]

date-time | null

DEPRECATED: Use created_at__gte instead

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_email__is

array of strings

Filters result to only message groups with the provided mailbox email

mailbox_email__is

offset

int32 | null

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

recipient_email__is

array of strings

Filters result to only message groups with the provided recipient email

recipient_email__is

reported_as_phish_by__is

array of strings

Filters result to only message groups with the provided reporter

reported_as_phish_by__is

reviewed

boolean | null

Filters result to only message groups which have or have not been reviewed

sender_display_name__is

array of strings

Filters result to only message groups with the provided sender display name

sender_display_name__is

sender_domain__is

array of strings

Filters result to only message groups with the provided sender domain

sender_domain__is

sender_email__is

array of strings

Filters result to only message groups with the provided sender email

sender_email__is

spam__is

array of strings

Filters result to only message groups with the provided spam status

spam__is

subject__is

array of strings

Filters result to only message groups with the provided subject

subject__is

user_reported

boolean | null

Filters result to only message groups with at least one reported message

vendor_id__is

array of strings

Filters result to only message groups with the provided vendor

vendor_id__is

Response

200OK