hornet icon

hornet

Interact with hornet API

Actions452

Emails Deny And Allowlisting → Emails Black White List Get

AI-generated

Summary

Fetch email allowlist or denylist entries for a given object with filtering, pagination, and sorting.

Inputs

  • object_id (required) — The object to get the list for.
  • type (required) — The type of the list (1=allowlist, 2=denylist).
  • owner — Filter the owner of the list entries.
  • value — Filter the value of the list entries.
  • description — Filter the description of the list entries.
  • all — Filter the owner or value of the list entries.
  • limit — Number of items per page (default 100).
  • page — Page index to navigate (default 0).
  • sort_key — Field to sort results by (type, value, owner; default type).
  • sort_order — Sort order (asc or desc; default asc).
  • bypassed_filters — Filter the list entries by bypassed filters (default [null]).
  • APP-ID (required) — Application identifier sent as a header for API authentication.
  • requestOptions.batching.batchSize — Items per batch for request batching (-1 disabled, 0 treated as 1; default 50).
  • requestOptions.batching.batchInterval — Milliseconds between batches (default 1000).
  • requestOptions.proxy — HTTP proxy to use.
  • requestOptions.timeout — Request timeout in milliseconds (default 10000).
  • requestOptions.allowUnauthorizedCerts — Whether to accept insecure SSL certificates (default false).

Output shape

array

Returns the list of email allowlist/denylist entries matching the supplied filters. Each entry contains the fields defined by the Hornet API (e.g., id, type, owner, value, description).

Examples

Example 1: Get the first 50 deny‑list entries for object 123, sorted by value descending.

Set object_id=123, type=2, limit=50, page=0, sort_key=value, sort_order=desc.

Links

Discussion