Name Type Default
status enum "all"

Domain status to filter by

Values: all, registered, transferring, pending, expired, cancelled
domain string null

Search by domain name. Use an asterisk (*) to search using wildcards (maximum of two asterisks allowed).

sort_by enum "name"

How to sort the domains, defaults to domain name

Values: cuid, name, status, registered_on, expires_on
order enum "default"

Order in ascending or descending order. Default is different depending on the sort_by attribute.

Values: default, asc, desc
max_per_page int 25

Maximum domains to return per page (this is hard limited to 100)

page int 1

Which page number to return


Code Name