---
title: "Get domain information"
method: GET
path: "/domains/{domain}"
tags: ["Domains"]
---

# Get domain information

`GET /domains/{domain}`

Get information about a configured domain, including the number of messages.

## Response `200`

Domain information

- object
  - `domain` Domain — Custom domain
    - `_id` string, domain — domain
    - `created` string, date-time — Date domain was created
    - `updated` string, date-time — Date domain settings were last updated
    - `enablews` boolean — boolean defaulting false indicating whether to publish messages via web socket to any subscribed web socket sessions
    - `hosted` boolean — boolean defaulting false indicating whether this is managed by mailsac (on msdc.co)
    - `isDefault` boolean — boolean defaulting false indicating whether this is the default domain for the account which will show in the sidebar first
    - `isPrivate` boolean — boolean defaulting true indicating whether inboxes and messages for this domain will be visible publicly
    - `lastVerificationErrors` string — during custom domain verification, this field indicates dns issues
    - `owner` string — the account to which this domain is assigned and can be managed
    - `verificationTxt` string — during custom domain verification, this field indicates value of a TXT record that must be added to the domain's DNS settings
    - `verified` boolean — boolean defaulting false indicating whether this domain has been verified via dns TXT record verificationTxt
    - `verifiedMx` boolean — boolean defaulting false indicating whether the domain will receive email successfully at Mailsac. Tthis domain has been verified via dns MX records when true.
  - `totalMessages` integer
  - `catchAllAddress` EmailAddress
    - `_id` string, email — the unique identifier of this email address is the email address itself
    - `info` string — Allows setting custom information about this email address.
    - `enabledws` boolean — boolean defaulting false indicating whether to publish messages via web socket when the user owning this inbox is subscribed
    - `forward` string, email — email address where messages to this inbox will be forwarded
    - `webhook` string, url — URL where messages to this inbox will be forwarded
    - `webhookSlack` string, url — Slack webhook endpoint where messages should be published
    - `webhookSlackToFrom` boolean — When webhookSlack is set, controls whether the message includes TO and FROM
    - `owner` string — Account that owns the address (owns the privacy)
    - `encryptedInbox` string, email — An alternate email address that will result in the message being delivered to this inbox. This is not always present.
    - `catchAll` string, domain — Indicates whether this is a catch-all address, and for which domain.
    - `implicit` boolean — When the user owns the domain but has not reserved the address individually, this field is set to true.
    - `created` string, date-time
    - `updated` string, date-time

## Other responses

- `401` — Not authorized. You may need to log in first.

---

[API](https://skmtc.dev/mailsac/apis/mailsac-api-specification.md) · [All operations](https://skmtc.dev/mailsac/apis/mailsac-api-specification/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/mailsac/mailsac-api-specification/revisions/5f8b55c76229/schema)