boundry.
RegionSydney, Australia
Documentation/Get a domain
GET/domains/{domainId}

Get a domain

Authentication

Bearer authentication is required for this operation.

Path parameters

NameTypeDescription
domainIdrequiredstring

Domain identifier.

Request examples

request.sh
bash
curl --request GET 'https://api.au.boundry.dev/domains/string' \
+  -H 'Authorization: Bearer $BOUNDRY_API_KEY' \
+

200 response

The domain.

FieldTypeDescription
capabilitiesrequiredobject

Domain capabilities.

receivingrequiredstring

Receiving capability. Values: "enabled", "disabled".

sendingrequiredstring

Sending capability. Values: "enabled", "disabled".

click_trackingrequiredboolean

Whether click tracking is enabled.

created_atrequiredstring (date-time)

Timestamp when the domain was created. Example: "2026-08-14T12:00:00.000Z".

idrequiredstring

Domain identifier. Example: "msg_01j0example".

namerequiredstring

Registered domain or subdomain. Example: "acme.com".

objectrequiredstring

Resource type discriminator. Values: "domain".

open_trackingrequiredboolean

Whether open tracking is enabled.

recordsrequiredarray

Required DNS records.

namerequiredstring

DNS record name. Example: "acme.com".

priorityinteger

MX priority when applicable.

recordrequiredstring

DNS record purpose. Values: "DKIM", "SPF", "MX", "Tracking".

statusrequiredstring

Verification status. Values: "verified", "not_started".

ttlrequiredstring

DNS time-to-live value. Example: "Auto".

typerequiredstring

DNS record type. Values: "TXT", "MX", "CNAME".

valuerequiredstring

DNS record value.

regionrequiredstring

Owning Boundry region. Values: "ap-southeast-2".

statusrequiredstring

Domain verification status. Values: "verified", "not_started".

tracking_subdomainrequiredstring

Tracking subdomain label. Example: "links".

response.jsonExample response
application/json
{
  "domainId": "dom_01j0example"
}

401 response

Invalid API key.

FieldTypeDescription
errorsarray

Detailed validation issues. Absent only for the historical 401 API-key envelope.

coderequiredstring

Zod validation issue code. Example: "invalid_format".

messagerequiredstring

Human-readable validation failure. Example: "Invalid email address".

pathrequiredstring

Dot-separated location of the invalid value. Example: "from".

messagerequiredstring

Human-readable error message. Example: "Request validation failed.".

namerequiredstring

Machine-readable error category. Values: "validation_error", "application_error", "not_found". Example: "validation_error".

response.jsonExample response
application/json
{
  "domainId": "dom_01j0example"
}

404 response

Domain not found.

FieldTypeDescription
errorsarray

Detailed validation issues. Absent only for the historical 401 API-key envelope.

coderequiredstring

Zod validation issue code. Example: "invalid_format".

messagerequiredstring

Human-readable validation failure. Example: "Invalid email address".

pathrequiredstring

Dot-separated location of the invalid value. Example: "from".

messagerequiredstring

Human-readable error message. Example: "Request validation failed.".

namerequiredstring

Machine-readable error category. Values: "validation_error", "application_error", "not_found". Example: "validation_error".

response.jsonExample response
application/json
{
  "domainId": "dom_01j0example"
}

422 response

Request validation failed.

FieldTypeDescription
errorsarray

Detailed validation issues. Absent only for the historical 401 API-key envelope.

coderequiredstring

Zod validation issue code. Example: "invalid_format".

messagerequiredstring

Human-readable validation failure. Example: "Invalid email address".

pathrequiredstring

Dot-separated location of the invalid value. Example: "from".

messagerequiredstring

Human-readable error message. Example: "Request validation failed.".

namerequiredstring

Machine-readable error category. Values: "validation_error", "application_error", "not_found". Example: "validation_error".

response.jsonExample response
application/json
{
  "domainId": "dom_01j0example"
}