Skip to main content
GET
/
api
/
e2
/
domains
/
{id}
JavaScript
import Inbound from 'inboundemail';

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

const domain = await client.domains.retrieve('id');

console.log(domain.id);
{
  "id": "<string>",
  "domain": "<string>",
  "status": "<string>",
  "canReceiveEmails": true,
  "hasMxRecords": true,
  "domainProvider": "<string>",
  "providerConfidence": "<string>",
  "lastDnsCheck": "2023-11-07T05:31:56Z",
  "lastSesCheck": "2023-11-07T05:31:56Z",
  "isCatchAllEnabled": true,
  "catchAllEndpointId": "<string>",
  "mailFromDomain": "<string>",
  "mailFromDomainStatus": "<string>",
  "mailFromDomainVerifiedAt": "2023-11-07T05:31:56Z",
  "receiveDmarcEmails": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "userId": "<string>",
  "stats": {
    "totalEmailAddresses": 123,
    "activeEmailAddresses": 123,
    "emailsLast24h": 123,
    "emailsLast7d": 123,
    "emailsLast30d": 123
  },
  "dnsRecords": [
    {
      "id": "<string>",
      "domainId": "<string>",
      "recordType": "<string>",
      "name": "<string>",
      "value": "<string>",
      "isRequired": true,
      "isVerified": true,
      "lastChecked": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "catchAllEndpoint": {
    "id": "<string>",
    "name": "<string>",
    "type": "<string>",
    "isActive": true
  },
  "verificationCheck": {
    "dnsRecords": [
      {
        "type": "<string>",
        "name": "<string>",
        "value": "<string>",
        "isVerified": true,
        "error": "<string>"
      }
    ],
    "sesStatus": "<string>",
    "isFullyVerified": true,
    "lastChecked": "2023-11-07T05:31:56Z",
    "dkimStatus": "<string>",
    "dkimVerified": true,
    "dkimTokens": [
      "<string>"
    ],
    "mailFromDomain": "<string>",
    "mailFromStatus": "<string>",
    "mailFromVerified": true
  },
  "authRecommendations": {
    "spf": {
      "name": "<string>",
      "value": "<string>",
      "description": "<string>"
    },
    "dmarc": {
      "name": "<string>",
      "value": "<string>",
      "description": "<string>"
    }
  },
  "inheritsFromParent": true,
  "parentDomain": "<string>"
}

Authorizations

Authorization
string
header
required

Your Inbound API key. Include it in the Authorization header as: Bearer

Path Parameters

id
string
required

Query Parameters

check
enum<string>
Available options:
true

Response

Response for status 200

id
string
required
domain
string
required
status
string
required
canReceiveEmails
boolean
required
hasMxRecords
boolean
required
domainProvider
string · null · null
required
providerConfidence
string · null · null
required
lastDnsCheck
string<date-time> · null · null
required
lastSesCheck
string<date-time> · null · null
required
isCatchAllEnabled
boolean
required
catchAllEndpointId
string · null · null
required
mailFromDomain
string · null · null
required
mailFromDomainStatus
string · null · null
required
mailFromDomainVerifiedAt
string<date-time> · null · null
required
receiveDmarcEmails
boolean
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
userId
string
required
stats
object
required
dnsRecords
object[]
required
catchAllEndpoint
object
verificationCheck
object
authRecommendations
object
inheritsFromParent
boolean
parentDomain
string · null · null