lumail.domains.list

SDK 2.1.0 · API v2 · GET /api/v2/domains

MethodGET

/api/v2/domains

Request Examples

import { Lumail } from "lumail";

const lumail = new Lumail({ apiKey: process.env.LUMAIL_API_KEY });
const { data, error } = await lumail.domains.list();
if (error) {
  throw error;
}
for (const domain of data.data) {
  console.log(domain.domain, domain.status);
}

Response Examples

{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "id": "dom_abc123",
      "domain": "mail.example.com",
      "status": "VERIFIED"
    }
  ]
}

[email protected] · lumail.domains

domains.list(): Promise<LumailResult<ListDomainsResponse>>

Permission: domains. The SDK takes no arguments and does not forward ?limit=. The HTTP route may still accept limit if you call it with fetch.

Parameters

No parameters.

Response Fields

Field	Type	Description
`object`	`"list"`	Discriminator. Always `list`.
`has_more`	boolean	`true` when the HTTP `limit` slice hid more rows. The SDK never sends `limit`, so this is usually `false`.
`data`	`DomainRecord[]`	Sending domains. Each row: `id`, `domain`, `status`, optional `region`, `createdAt`, `sesRecords`, `dnsRecords`, `message`.

data is { object, data, has_more }. Failures return { data: null, error: { name, message, statusCode } }.

Previouslumail.domains Nextlumail.domains.create