Skip to content
VaartixVaartix Docs

List domains

GET
/domains
curl --request GET \
  --url https://api.vaartix.com/domains \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Your team’s domains.

Media typeapplication/json
object
data
required
Array<object>
object
id
string
name
string
status
string
Allowed values: pending verified failed temporary_failure
region
string
records

3 DKIM CNAMEs, the MAIL FROM MX and SPF TXT, and a recommended DMARC TXT.

Array<object>
object
type
string
Allowed values: CNAME MX TXT
name
string
value
string
priority

MX records only.

integer
status

Not set for the recommended DMARC record.

string
Allowed values: pending verified failed
openTracking
boolean
clickTracking
boolean
verifiedAt
string | null format: date-time
lastCheckedAt
string | null format: date-time
createdAt
string format: date-time

Example 

{
  "data": [
    {
      "id": "dom_5bvatg1v837anztd",
      "name": "acme.in",
      "status": "pending",
      "region": "ap-south-1",
      "records": [
        {
          "type": "CNAME",
          "name": "send.acme.in",
          "value": "feedback-smtp.ap-south-1.amazonses.com",
          "status": "pending"
        }
      ]
    }
  ]
}

401

Section titled “401”

unauthorized: the API key is missing, invalid or revoked.

Media typeapplication/json
object
error
required
object
type
required

Stable, machine-readable error type.

string
Allowed values: validation_error unauthorized forbidden not_found conflict rate_limited daily_quota_exceeded domain_not_verified invalid_from_address account_paused idempotency_conflict bad_request internal_error
message
required

Human-readable explanation, safe to show to developers.

string

Example 

{
  "error": {
    "type": "validation_error"
  }
}

403

Section titled “403”

forbidden: the key cannot do this, for example a send-only key on a management endpoint.

Media typeapplication/json
object
error
required
object
type
required

Stable, machine-readable error type.

string
Allowed values: validation_error unauthorized forbidden not_found conflict rate_limited daily_quota_exceeded domain_not_verified invalid_from_address account_paused idempotency_conflict bad_request internal_error
message
required

Human-readable explanation, safe to show to developers.

string

Example 

{
  "error": {
    "type": "validation_error"
  }
}