Documentation/List domains

List domains

List the domains configured for the selected regional project.

GET/domains

`200` response

Domain list

FieldTypeDescription

objectrequiredstring

Values: "list".

datarequiredarray

data[].idrequiredstring

data[].namerequiredstring

data[].statusrequiredstring

data[].regionrequiredstring

data[].recordsrequiredarray

data[].tlsstring

data[].managed_unsubscribe_defaultboolean

Whether omitted or null email unsubscribe values enable Boundry-managed RFC 8058 headers.

data[].capabilitiesobject

has_morerequiredboolean

request.ts

typescript

import { Boundry } from "boundry-sdk";

const boundry = new Boundry({
  apiKey: process.env.BOUNDRY_API_KEY!,
});

const response = await boundry.api.listDomains({});

response.json200 response

application/json

{
  "object": "list",
  "data": [
    {
      "id": "string",
      "name": "string",
      "status": "string",
      "region": "string",
      "tls": "string",
      "managed_unsubscribe_default": true
    }
  ],
  "has_more": true
}