list_bought_domains

These are the registrations the workspace owns, bought on its Domains page or with buy_domain. They are not the custom domains of a site, which get_domain_status reads: a bought domain serves a site only once it is added to that site, with add_custom_domain or by buy_domain when it was passed connectProjectId. Every member of the workspace can list them.

Each row carries _id, the domainId every bought domain tool takes, Name, State, Registered_At, Expires_At, RenewalPriceCents, what renewing costs in US cents for RenewalYears years, the shortest renewal term, Locked, whether the transfer lock is on, PrivacyEnabled, Nameservers, DefaultNameservers, Modulify's nameservers, the ones it started with, UsesProviderDns, ManagedRecordCount, how many records Modulify keeps in it for the workspace's sites and email domains, DnsSyncError, what keeps Modulify from adding one of them or null, and, for a failed domain, Failure_Reason.

Four fields report auto-renew. AutoRenew is true while Modulify renews the domain itself before it expires, and AutoRenew_By is the id of the person whose saved card pays for that, or null. AutoRenew_Failed_At and AutoRenew_Error say when and why the latest automatic renewal for the current Expires_At failed, and are null otherwise.

RenewBy is the last day the domain can still be renewed once it has expired, at the normal renewal price. It is null while Name.com has not reported the grace days of the domain's extension yet. After that day Name.com removes the domain from the account and it shows as released, and Modulify has no redemption or restore step. See After a domain expires.

State	Meaning
pending	The registrar has not confirmed the registration yet, so add_custom_domain still refuses it
active	Registered, with more than 30 days left
expiring	In its last 30 days
expired	Expires_At has passed. It can still be renewed until RenewBy
failed	The order did not go through and the payment was refunded
released	The workspace no longer holds it at Name.com, because it moved to another registrar or lapsed and was deleted or registered again

A failed or released domain can only be cleared from the list with remove_domain_from_list. UsesProviderDns is true while the domain uses Modulify's nameservers: the records the DNS record tools change are then the ones that answer for it, and Modulify adds and removes the records the workspace's sites and email domains under it need by itself. A domain with AutoRenew true is renewed by Modulify before Expires_At, see set_domain_auto_renew. Name.com's own auto renew always stays off, so any other domain is renewed only once its renewal is paid, and the tool tells the client to offer renew_domain when one is expired, when AutoRenew_Error is set, or when one with AutoRenew false is expiring.

Narrow the list with term and status, and order it with sort. It returns 25 per page, so pass offset to go further, and the response carries the total count. See Read the list.

Inputs

Input	Type	Required	Description
workspaceId	string	Yes	The workspace id, from list_workspaces.
term	string	No	Keeps only domains whose name matches this text. Up to 253 characters.
status	string	No	Keeps only domains in one state: pending, active, expiring, expired, failed or released.
sort	string	No	The order to list them in: newest, the default, oldest, name, or expires, which puts the soonest expiry first and domains with no expiry date yet, such as pending or failed ones, last.
offset	integer	No	How many domains to skip, 0 or more. Pages are 25 long. Defaults to 0.