SUsublime
Message Groups

Search message groups

Changed on

Search all message groups

get/v0/message-groups/search

Request

  • Base URL
    https://platform.sublime.security
  • URL
    https://platform.sublime.security/v0/message-groups/search
  • Auth
    HTTP bearer

Query parameters

anystring nullable

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

attachment_md5string nullable

Search for messages containing an attachment MD5 match

attachment_sha1string nullable

Search for messages containing an attachment SHA1 match

attachment_sha256string nullable

Search for messages containing an attachment SHA256 match

created_at[gte]string date-time nullable

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]string date-time nullable

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]string date-time nullable

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_namestring nullable

Search in attachment filenames (case insensitive wildcard match)

first_reported_as_phish_at[gte]string date-time nullable

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]string date-time nullable

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.

fromstring nullable

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

limitinteger nullable

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

mailboxstring nullable

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

message_idstring nullable

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

offsetinteger nullable

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

senderstring nullable

Search in the From field (case insensitive wildcard match)

statesstring[]

Search for messages in any of the given states

subjectstring nullable

Search in the message subject (case insensitive wildcard match)

tostring nullable

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

typestring[]

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

Response

OK

countinteger required

Count of messages groups for this page

stats_limit_exceededboolean

Indicates if 'total' is a lower bound

totalinteger required

Total number of messages groups matching the search

Changes

  • 081203bd7147Revision changes
    • info

      for the query request parameter type, the type was generalized from string to array

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status