API Reference

Tenants

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Accounts

List tenant accounts

client.tenants.accounts.list(stringtenantID, RequestOptionsoptions?): SinglePage<TenantAccount { id, created_on, name, 3 more } >

GET/tenants/{tenant_id}/accounts

ModelsExpand Collapse

TenantAccount { id, created_on, name, 3 more }

id: string

created_on: string

formatdate-time

name: string | null

settings: Settings { abuse_contact_email, access_approval_expiry, api_access_enabled, 3 more }

abuse_contact_email: string | null

access_approval_expiry: string | null

formatdate-time

api_access_enabled: boolean | null

Deprecateddefault_nameservers: string | null

Use DNS Settings instead. Deprecated.

enforce_twofactor: boolean | null

Deprecateduse_account_custom_ns_by_default: boolean | null

Use DNS Settings instead. Deprecated.

type: "standard" | "enterprise"

One of the following:

"standard"

"enterprise"

tags?: Record<string, string>

Account tags, present only when include_tags=true is requested.