List domains already added to this Pingram account for email
const url = 'https://api.pingram.io/domains';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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
object
What is still missing before new mail can use the tracking subdomain.
Keyed by record id — computed on domain API responses, not stored in DB.
object
DNS record the customer must publish for domain verification.
object
Relative name for the parent DNS zone UI (e.g. pingram._domainkey.testing).
Full hostname (e.g. pingram._domainkey.testing.something.com).
DNS record the customer must publish for domain verification.
object
Relative name for the parent DNS zone UI (e.g. pingram._domainkey.testing).
Full hostname (e.g. pingram._domainkey.testing.something.com).
DNS record the customer must publish for domain verification.
object
Relative name for the parent DNS zone UI (e.g. pingram._domainkey.testing).
Full hostname (e.g. pingram._domainkey.testing.something.com).
DNS record the customer must publish for domain verification.
object
Relative name for the parent DNS zone UI (e.g. pingram._domainkey.testing).
Full hostname (e.g. pingram._domainkey.testing.something.com).
DNS record the customer must publish for domain verification.
object
Relative name for the parent DNS zone UI (e.g. pingram._domainkey.testing).
Full hostname (e.g. pingram._domainkey.testing.something.com).
DNS record the customer must publish for domain verification.
object
Relative name for the parent DNS zone UI (e.g. pingram._domainkey.testing).
Full hostname (e.g. pingram._domainkey.testing.something.com).
Subdomain recipients see on click tracking, the open pixel, and the unsubscribe page, such as links.
Whether tracked links on this subdomain are not started, waiting, active, or failed.
Why tracked links on this subdomain are not active, when setup did not succeed.
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
Standard error response for API errors.
object
Unique tracking ID for the request.
Structured error details for API error responses.
object
Machine-readable error code.
Human-readable error message.
Actionable hint for fixing the error.
Examplegenerated
{ "trackingId": "example", "error": { "code": "example", "message": "example", "fix": "example" }}401
Unauthorized
402
Payment Required - usage limits exceeded
Standard error response for API errors.
object
Unique tracking ID for the request.
Structured error details for API error responses.
object
Machine-readable error code.
Human-readable error message.
Actionable hint for fixing the error.
Examplegenerated
{ "trackingId": "example", "error": { "code": "example", "message": "example", "fix": "example" }}500
Internal Server Error
502
Bad Gateway - provider error
Standard error response for API errors.
object
Unique tracking ID for the request.
Structured error details for API error responses.
object
Machine-readable error code.
Human-readable error message.
Actionable hint for fixing the error.
Examplegenerated
{ "trackingId": "example", "error": { "code": "example", "message": "example", "fix": "example" }}