GET
/
domains
TypeScript
import Nuntly from '@nuntly/sdk';

const client = new Nuntly({
  apiKey: 'My API Key',
});

// Automatically fetches more pages as needed.
for await (const domainListResponse of client.domains.list()) {
  console.log(domainListResponse.id);
}
{
  "data": [
    {
      "id": "dns_01jh8xggryggczvjv4xfff4rwn",
      "org_id": "org_01jh6jk82zjq9deye73h0mzcaq",
      "name": "info.tomlinson.ai",
      "status": "bootstrapping",
      "sending_status": "disabled",
      "status_at": "2025-01-10T20:11:55.038Z",
      "created_at": "2025-01-10T20:11:55.038Z",
      "modified_at": "2025-01-10T20:11:55.038Z",
      "region": "eu-west-1",
      "kind": "domain"
    }
  ],
  "next_cursor": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer HTTP authentication. Allowed headers Authorization: Bearer <API_KEY>

Query Parameters

limit
number
default:10

The number of emails to return

Required range: 1 <= x <= 30
cursor
string

The cursor to use for pagination

Response

200
application/json

A successful response

The response is of type object.