Skip to content

List domains already added to this Pingram account for email

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

List domains already added to this Pingram account for email. Each entry includes verification status and the DNS records Pingram expects you to publish. Does not search a registrar, purchase or transfer a domain, change DNS, or include domains that have not been added to this account.

Authorizations

Responses

200

Successful response

Media typeapplication/json
Array<object>
object
waitingFor

What is still missing before new mail can use the tracking subdomain.

string
sender
required
string
status
required
string
Allowed values: SUCCESS PENDING FAILED TEMPORARY_FAILURE NOT_STARTED
lastSync
required
string format: date-time
verificationTokens
Array<string>
mailFromDomainStatus
string
Allowed values: PENDING SUCCESS FAILED TEMPORARY_FAILURE
createdAt
required
string
privateDKIMKey
string
reminderSentAt
string
selector
required
string
verificationRecords

Keyed by record id — computed on domain API responses, not stored in DB.

object
dkim

DNS record the customer must publish for domain verification.

object
recordType
required
string
Allowed values: TXT MX CNAME
recordName
required

Relative name for the parent DNS zone UI (e.g. pingram._domainkey.testing).

string
host
required

Full hostname (e.g. pingram._domainkey.testing.something.com).

string
recordValue
required
string
priority
number
required
boolean
mail_from_spf

DNS record the customer must publish for domain verification.

object
recordType
required
string
Allowed values: TXT MX CNAME
recordName
required

Relative name for the parent DNS zone UI (e.g. pingram._domainkey.testing).

string
host
required

Full hostname (e.g. pingram._domainkey.testing.something.com).

string
recordValue
required
string
priority
number
required
boolean
mail_from_mx

DNS record the customer must publish for domain verification.

object
recordType
required
string
Allowed values: TXT MX CNAME
recordName
required

Relative name for the parent DNS zone UI (e.g. pingram._domainkey.testing).

string
host
required

Full hostname (e.g. pingram._domainkey.testing.something.com).

string
recordValue
required
string
priority
number
required
boolean
dmarc

DNS record the customer must publish for domain verification.

object
recordType
required
string
Allowed values: TXT MX CNAME
recordName
required

Relative name for the parent DNS zone UI (e.g. pingram._domainkey.testing).

string
host
required

Full hostname (e.g. pingram._domainkey.testing.something.com).

string
recordValue
required
string
priority
number
required
boolean
inbound_mx

DNS record the customer must publish for domain verification.

object
recordType
required
string
Allowed values: TXT MX CNAME
recordName
required

Relative name for the parent DNS zone UI (e.g. pingram._domainkey.testing).

string
host
required

Full hostname (e.g. pingram._domainkey.testing.something.com).

string
recordValue
required
string
priority
number
required
boolean
trackingCname

DNS record the customer must publish for domain verification.

object
recordType
required
string
Allowed values: TXT MX CNAME
recordName
required

Relative name for the parent DNS zone UI (e.g. pingram._domainkey.testing).

string
host
required

Full hostname (e.g. pingram._domainkey.testing.something.com).

string
recordValue
required
string
priority
number
required
boolean
trackingSubdomain

Subdomain recipients see on click tracking, the open pixel, and the unsubscribe page, such as links.

string
trackingStatus

Whether tracked links on this subdomain are not started, waiting, active, or failed.

string
Allowed values: NOT_STARTED PENDING ACTIVE FAILED
trackingFailureReason

Why tracked links on this subdomain are not active, when setup did not succeed.

string
Allowed values: cname_missing cname_proxied cname_conflict cert_failed probe_failed dkim_lost
Example
[
{
"status": "SUCCESS",
"mailFromDomainStatus": "PENDING",
"verificationRecords": {
"dkim": {
"recordType": "TXT"
},
"mail_from_spf": {
"recordType": "TXT"
},
"mail_from_mx": {
"recordType": "TXT"
},
"dmarc": {
"recordType": "TXT"
},
"inbound_mx": {
"recordType": "TXT"
},
"trackingCname": {
"recordType": "TXT"
}
},
"trackingStatus": "NOT_STARTED",
"trackingFailureReason": "cname_missing"
}
]

400

Bad Request - validation errors, invalid input

Media typeapplication/json

Standard error response for API errors.

object
trackingId
required

Unique tracking ID for the request.

string
error
required

Structured error details for API error responses.

object
code
required

Machine-readable error code.

string
message
required

Human-readable error message.

string
fix

Actionable hint for fixing the error.

string
Examplegenerated
{
"trackingId": "example",
"error": {
"code": "example",
"message": "example",
"fix": "example"
}
}

401

Unauthorized

402

Payment Required - usage limits exceeded

Media typeapplication/json

Standard error response for API errors.

object
trackingId
required

Unique tracking ID for the request.

string
error
required

Structured error details for API error responses.

object
code
required

Machine-readable error code.

string
message
required

Human-readable error message.

string
fix

Actionable hint for fixing the error.

string
Examplegenerated
{
"trackingId": "example",
"error": {
"code": "example",
"message": "example",
"fix": "example"
}
}

500

Internal Server Error

502

Bad Gateway - provider error

Media typeapplication/json

Standard error response for API errors.

object
trackingId
required

Unique tracking ID for the request.

string
error
required

Structured error details for API error responses.

object
code
required

Machine-readable error code.

string
message
required

Human-readable error message.

string
fix

Actionable hint for fixing the error.

string
Examplegenerated
{
"trackingId": "example",
"error": {
"code": "example",
"message": "example",
"fix": "example"
}
}