List domains for an environment

Returns a paginated list of inbound-email domains in the current environment. Supports cursor pagination and a name contains filter.

GET /v1/domains

TypeScript

TypeScript

import { Novu } from "@novu/api";

const novu = new Novu({
  secretKey: "YOUR_SECRET_KEY_HERE",
});

async function run() {
  const result = await novu.domains.list({
    limit: 10,
  });

  console.log(result);
}

run();

200

{
  "data": [
    {
      "_id": "<string>",
      "name": "<string>",
      "mxRecordConfigured": true,
      "_environmentId": "<string>",
      "_organizationId": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "dnsProvider": "<string>",
      "expectedDnsRecords": [
        {
          "type": "MX",
          "name": "inbound",
          "content": "inbound-smtp.us-east-1.amazonaws.com",
          "ttl": "Auto",
          "priority": 10
        }
      ],
      "data": {}
    }
  ],
  "next": "<string>",
  "previous": "<string>",
  "totalCount": 123,
  "totalCountCapped": true
}

Authorizations

Authorization · string · header · required

API key authentication. Allowed headers-- "Authorization: ApiKey <novu_secret_key>".

Headers

idempotency-key · string

A header for idempotency purposes

Query Parameters

after · string

Cursor for pagination indicating the starting point after which to fetch results.

before · string

Cursor for pagination indicating the ending point before which to fetch results.

limit · number

Limit the number of items to return

orderDirection · enum<string>

Direction of sorting

Available options: ASC, DESC

orderBy · string

Field to order by

includeCursor · boolean

Include cursor item in response

name · string

Domain name to filter results by.

Response

200

application/json

OK

data · object[] · required

List of returned domains

Show child attributes

next · string | null · required

The cursor for the next page of results, or null if there are no more pages.

previous · string | null · required

The cursor for the previous page of results, or null if this is the first page.

totalCount · number · required

The total count of items (up to 50,000)

totalCountCapped · boolean · required

Whether there are more than 50,000 results available