hornet icon

hornet

Interact with hornet API

Actions452

Compliance Filter → Compliance Filter Get

AI-generated

Summary

Fetch compliance filter entries for a given object

Inputs

  • object_id (required) — ID of the object (user, customer or partner) whose compliance filters are retrieved.
  • direction — Direction of the mail: 1 = INCOMING, 2 = OUTGOING. If omitted or 0, no direction filter is applied.
  • page — Zero‑based page number for pagination. Defaults to 0.
  • limit — Maximum number of entries to return per page. Defaults to 50.
  • only_active — When true returns only activated entries, when false returns only deactivated entries. Note: this filter does NOT affect the returned num_found_items and num_found_active_items fields. Defaults to true.
  • APP-ID (required) — Application identifier issued by Hornet Security, sent as a custom HTTP header.

Output shape

object

The response contains an array of compliance filter entries under a data property (or similar) and the metadata fields num_found_items (total matches) and num_found_active_items (total active matches). Exact entry structure follows the API definition.

Examples

Example 1: Get the first page of active compliance filters for object 12345, incoming direction only

object_id: 12345, direction: 1, page: 0, limit: 50, only_active: true

Links

Discussion