Skip to main content
GET
/
domains
JavaScript
import Nuntly from '@nuntly/sdk';

const client = new Nuntly({
  apiKey: process.env['NUNTLY_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const domainListResponse of client.domains.list()) {
  console.log(domainListResponse.id);
}
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": "bootstrapping",
      "sendingStatus": "enabled",
      "createdAt": "<string>",
      "region": "eu-west-1"
    }
  ],
  "nextCursor": "<string>"
}

Authorizations

Authorization
string
header
required

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

Query Parameters

cursor
string

The cursor to retrieve the next page of results

limit
number
default:30

The maximum number of results to return

Required range: 1 <= x <= 30

Response

200 response

The list of domains for the organization

data
object[]
required
nextCursor
string