hornet icon

hornet

Interact with hornet API

Actions452

Domains → Domains Get

AI-generated

Summary

Retrieve a paginated list of domains associated with a specified customer, filtered optionally by domain name, domain type, and spam filter activation status.

Inputs

  • object_id (required) — Numeric identifier of the customer for whom to retrieve domains.
  • APP-ID (required) — Unique application identifier issued to the user, sent as a header for authentication.
  • name — Optional string to filter results by domain name.
  • domain_type — Optional JSON array to filter results by domain type.
  • only_with_spam_filter_activated — Boolean to restrict results to domains with Spam and Malware Protection activated; defaults to true.
  • limit — Number specifying the maximum items per page to return; defaults to 100.
  • page — Number specifying the page index for paginated results; defaults to 0.

Output shape

a JSON object containing a list of domain records corresponding to the specified filters and pagination.

Results are paginated, respecting the limit and page parameters. The request requires the APP-ID header and the object_id parameter. Optional query parameters refine the returned domain list based on name, domain type, and spam filter status.

Examples

Example 1: Get first 100 domains for customer 123 with active spam filter

Set object_id to 123, APP-ID header to your app id, only_with_spam_filter_activated to true, and use defaults for limit=100 and page=0.

Links

Discussion