Get a domain | Resend API (unofficial showcase)

1 parameter

domain_idstringrequired

The identifier of the domain to retrieve.

1 status code

200Returns the domain's identifier, name, status, creation time, region, tracking settings, capabilities, and DNS records.

objectstringoptional

The type of object.

idstringoptional

The ID of the domain.

namestringoptional

The name of the domain.

statusstringoptional

The status of the domain.

Allowed:pendingverifiedfailednot_startedpartially_verifiedpartially_failed

created_atstringoptional

The date and time the domain was created.

regionstringoptional

The region where the domain is hosted.

open_trackingbooleanoptional

Whether open tracking is enabled for this domain.

click_trackingbooleanoptional

Whether click tracking is enabled for this domain.

tracking_subdomainstringoptional

The subdomain used for click and open tracking.

capabilitiesobjectoptional

Configure the domain capabilities for sending and receiving emails. At least one capability must be enabled.

recordsarray<object>optional

Error handling

The domain_id path parameter must identify an existing domain.

import { Client } from "@octridev/resend";

const client = new Client({
  baseUrl: "https://api.resend.com",
  auth: { bearer: process.env.API_TOKEN },
});

const result = await client.domains.get({ domainId: "3fa85f64-5717-4562-b3fc-2c963f66afa6" });

{
  "object": "domain",
  "id": "d91cd9bd-1176-453e-8fc1-35364d380206",
  "name": "example.com",
  "status": "not_started",
  "created_at": "2023-04-26 20:21:26.347412+00",
  "region": "us-east-1",
  "open_tracking": true,
  "click_tracking": true,
  "tracking_subdomain": "example_value",
  "capabilities": {
    "sending": "enabled",
    "receiving": "enabled"
  },
  "records": [
    {
      "record": "SPF",
      "name": "Example Name",
      "type": "MX",
      "ttl": "example_value",
      "status": "pending",
      "value": "example_value",
      "priority": 1
    }
  ]
}

Request

Response

Errors