Skip to main content
GET
/
v1
/
domains
cURL
curl --request GET \
  --url https://app.usesend.com/api/v1/domains \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": 1,
    "name": "example.com",
    "teamId": 1,
    "status": "NOT_STARTED",
    "publicKey": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "dnsRecords": [
      {
        "type": "TXT",
        "name": "mail",
        "value": "v=spf1 include:amazonses.com ~all",
        "ttl": "Auto",
        "status": "NOT_STARTED",
        "priority": "10",
        "recommended": true
      }
    ],
    "region": "us-east-1",
    "clickTracking": false,
    "openTracking": false,
    "dkimStatus": "<string>",
    "spfDetails": "<string>",
    "dmarcAdded": false,
    "isVerifying": false,
    "errorMessage": "<string>",
    "subdomain": "<string>",
    "verificationError": "<string>",
    "lastCheckedTime": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

Retrieve domains accessible by the API key

​
id
number
required

The ID of the domain

Example:

1

​
name
string
required

The name of the domain

Example:

"example.com"

​
teamId
number
required

The ID of the team

Example:

1

​
status
enum<string>
required
Available options:
NOT_STARTED,
PENDING,
SUCCESS,
FAILED,
TEMPORARY_FAILURE
​
publicKey
string
required
​
createdAt
string
required
​
updatedAt
string
required
​
dnsRecords
object[]
required
​
region
string
default:us-east-1
​
clickTracking
boolean
default:false
​
openTracking
boolean
default:false
​
dkimStatus
string | null
​
spfDetails
string | null
​
dmarcAdded
boolean
default:false
​
isVerifying
boolean
default:false
​
errorMessage
string | null
​
subdomain
string | null
​
verificationError
string | null
​
lastCheckedTime
string | null