Skip to main content

Methods

List

Retrieves a list of all domains.

ListWithContext

Retrieves a list of all domains with context support.

ListWithOptions

Retrieves a list of domains with pagination options.

Parameters

ListOptions (for ListWithOptions)

*int
Maximum number of domains to return per page
*string
Cursor for pagination - retrieve results after this cursor
*string
Cursor for pagination - retrieve results before this cursor

Response

ListDomainsResponse

string
Object type (“list”)
[]Domain
Array of domain objects. Each domain contains:
  • id (string): Domain identifier
  • object (string): Object type
  • name (string): Domain name
  • created_at (string): Creation timestamp
  • status (string): Verification status
  • region (string): Email sending region
  • records ([]Record): DNS records
bool
Whether there are more results available for pagination

Examples

Basic Usage

With Pagination

With Context