NameInstall

Summary

Retrieves a paginated list of domains in the authenticated account, with options to filter, sort, and extract domain records.

Inputs

• perPage (required) — Number of records to return per request (default: 100).
• page (required) — Page number to retrieve (default: 1).
• sort — Domain property to order by (default: 'domainName').
• dir — Sort direction: 'asc' or 'desc' (default: 'asc').
• domainName — Filters domains by exact name or wildcard.
• tld — Filters domains by specific Top Level Domain.
• locked — Filter for locked domains ('Any', 'True', or 'False').
• createDate — Filters domains created on this specific date (YYYY-MM-DD).
• createDateStart — Filters domains created on or after this date (YYYY-MM-DD).
• createDateEnd — Filters domains created on or before this date (YYYY-MM-DD).
• expireDate — Filters domains expiring on this specific date.
• expireDateStart — Filters domains expiring on or after this date.
• expireDateEnd — Filters domains expiring on or before this date.
• privacyEnabled — Filter for domains with privacy enabled ('Any', 'True', or 'False').
• isPremium — Filter for premium domains ('Any', 'True', or 'False').
• autorenewEnabled — Filter for domains with auto-renew enabled ('Any', 'True', or 'False').
• orderId — Filters domains by order ID.
• includeRenewalPrice — Whether to include renewal pricing in the results.
• extractedDomains — When true, wraps the response in a 'domains' array and sets the root property to 'extractedDomains'.
• requestOptions — Node-level request settings including batching, timeout, proxy, and SSL options.

Output shape

A list of domain records or a single domain object if 'extractedDomains' is enabled.

The 'extractedDomains' option transforms the output so the root property is 'extractedDomains', containing either a 'domains' array from the API or a single-item array wrapping the entire response body.

Examples

Example 1: List first 50 domains sorted by expiration date in descending order.

Set perPage to 50, page to 1, sort to 'expireDate', and dir to 'desc'.

Example 2: Find all domains expiring in the next 30 days.

Use expireDateStart with today's date. Optionally enable extractedDomains to simplify output handling.

Example 3: Retrieve only premium domains created in 2024.

Set isPremium to 'True' and createDateStart to '2024-01-01'.

Links

• n8n community nodes installation guide