hornet icon

hornet

Interact with hornet API

Actions452

Mailboxes → Mailboxes Post

AI-generated

Summary

Search mailboxes by POST with filter criteria.

Inputs

  • object_id — The ID of an object (user, customer or partner). Sent as a query parameter.
  • APP-ID (required) — Application identifier header for authentication.
  • name — Filter for mailboxes whose name contains the given string (searches email addresses). Sent in the request body.
  • limit — Number of items per page for pagination. Sent in the request body.
  • page — Page index for pagination. Sent in the request body.
  • have_email_address — DEPRECATED: not used. Sent in the request body.
  • include_alias_matches — Include matches in alias addresses. Sent in the request body.
  • type — Filter for mailbox type. Sent as a parsed JSON array in the request body.
  • environment — ID of the advanced routing environment, 'primary' for primary environment. Sent in the request body.
  • mfa_enabled — Filter for mailboxes that have MFA enabled (true) or not (false). Sent in the request body.
  • sso_enabled — Filter for mailboxes that have SSO enabled (true) or not (false). Sent in the request body.
  • status — Filter for mailboxes that are activated (true) or deactivated (false). Sent in the request body.
  • show_external_id — Whether to show external ID in the response. Sent in the request body.
  • requestOptions — Additional HTTP options such as batching, SSL verification, proxy, and timeout.

Output shape

Array of mailbox objects as returned by the Hornet API.

The response body contains the list of mailboxes matching the supplied filters.

Links

Discussion