Domains

List domains

Returns all domains belonging to the account. Optionally filtered by status or search query.

get/domains

Request

  • Base URL
    https://api.mailforge.ai/public
  • Auth
    API key in header Authorization

Query parameters

status'active' | 'pending' | 'failed' | 'expired' | 'scheduled_for_deletion' | 'not_paid'

Filter by status

searchstring

Search domains by id, workspace id, domain name, forward-to domain, or status

Response

OK

autoRenewFailedReasonstring
autoRenewLastProcessedExpirationstring
autoRenewProcessedAtstring
autoRenewStatus'disabled' | 'enabled' | 'failed'
createdAtstring
dmarcEmailstring
expiresAtstring
failedReasonstring
forwardToDomainstring
idstring
isTransferredboolean
mailDeletionAtstring
mailServerIdinteger
nameserversstring[]
priceCentsinteger
setupIdstring
sldstring
status'draft' | 'active' | 'pending' | 'failed' | 'expired' | 'warning' | 'scheduled_for_deletion' | 'not_paid'
tldstring
type'v2'
updatedAtstring
workspaceIdstring

Changes

No recorded changes to this operation across all 1 revision of this API.