Skip to main content
GET
/
api
/
email
/
domain
/
grey-label
Get the grey label domain for the account
curl --request GET \
  --url https://api-{region}-{cluster}.benchmarkemail.com/api/email/domain/grey-label \
  --header 'X-API-Key: <api-key>'
{
  "_id": "<string>",
  "createdAt": "<string>",
  "dkim": {
    "records": [
      {
        "name": "<string>",
        "ttl": 123,
        "type": "<string>",
        "value": "<string>"
      }
    ],
    "status": "<string>",
    "verificationInfo": {
      "errorCode": "<string>",
      "lastRecordFound": "<string>"
    }
  },
  "dmarc": {
    "records": [
      {
        "name": "<string>",
        "ttl": 123,
        "type": "<string>",
        "value": "<string>"
      }
    ],
    "status": "<string>",
    "verificationInfo": {
      "errorCode": "<string>",
      "lastRecordFound": "<string>"
    }
  },
  "domain": "<string>",
  "identity": {
    "mailFrom": {
      "status": "<string>",
      "subdomain": "<string>"
    },
    "status": "<string>",
    "verificationInfo": {
      "errorCode": "<string>",
      "lastCheckedAt": "2023-11-07T05:31:56Z",
      "lastRecordFound": "<string>",
      "lastSuccessAt": "2023-11-07T05:31:56Z"
    },
    "verificationStatus": "<string>"
  },
  "isReadyForSending": true,
  "lastCheckedAt": "<string>",
  "linkTracking": {
    "records": [
      {
        "name": "<string>",
        "ttl": 123,
        "type": "<string>",
        "value": "<string>"
      }
    ],
    "status": "<string>",
    "verificationInfo": {
      "errorCode": "<string>",
      "lastRecordFound": "<string>"
    }
  },
  "nameServer": "<string>",
  "provider": "<string>",
  "spf": {
    "records": [
      {
        "name": "<string>",
        "ttl": 123,
        "type": "<string>",
        "value": "<string>"
      }
    ],
    "status": "<string>",
    "verificationInfo": {
      "lastRecordFound": {
        "mx": "<string>",
        "txt": "<string>"
      }
    }
  },
  "sslCertStatus": "<string>",
  "status": "<string>",
  "type": "<string>",
  "updatedAt": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

API key authentication

Response

Successfully fetched

​
_id
string

Id of the domain

​
createdAt
string

Date of creation

​
dkim
object

DKIM (DomainKeys Identified Mail) configuration (multi-record domains only)

​
dmarc
object

DMARC (Domain-based Message Authentication, Reporting & Conformance) configuration with status and DNS records (multi-record domains only)

​
domain
string

Domain name

​
identity
object

Domain identity information (not present in multi-record domains - see spf/dkim sections instead)

​
isReadyForSending
boolean

Is the domain ready for sending

​
lastCheckedAt
string

Date of last domain verification

​
linkTracking
object

Link tracking configuration with status and DNS records (multi-record domains only)

​
nameServer
string

Name server for the domain

​
provider
string

Domain provider

​
spf
object

SPF (Sender Policy Framework) configuration with mail-from records (multi-record domains only)

​
sslCertStatus
string

SSL certificate status (pending, created, renewed, expired, failed)

​
status
string

Status of the domain (verifying, verified)

​
type
string

Type of the domain (private, grey-label, multi-record)

​
updatedAt
string

Date of update