Get all domains for the account
This API is to get all domain associated with the account. It also provides details of the retrieved domain like the DNS records, Tracking details, Active/Blocked status,etc.
Please log in to see full path URL. Learn why.
get
/email/1/domains
Authorizations:
Request rate limit:
1000 requests / second (per account)
query Parameters
size | integer [ 1 .. 20 ] Default: 10 Maximum number of domains to be viewed per page. Default value is 10 with a maximum of 20 records per page. |
page | integer >= 0 Default: 0 Page number you want to see. Default is 0. |
Responses
200
OK
400
Bad Request.
401
Unauthorized
403
Forbidden
429
Too Many Requests
500
Internal Server Error
Request samples
- cURL
- Java
- C#
- Go
- Python
- PHP
- JavaScript
- NodeJs
- Ruby
Example
cURL
Copy
curl -L -g 'https://{baseUrl}/email/1/domains' \ -H 'Authorization: {authorization}' \ -H 'Accept: application/json'
Response samples
- 200
- 400
- 401
- 403
- 429
- 500
Content type
application/json
Copy
Collapse all {- "paging": {
- "page": 0,
- "size": 0,
- "totalPages": 0,
- "totalResults": 0
}, - "results": [
- {
- "domainId": 1,
- "domainName": "example.com",
- "active": false,
- "tracking": {
- "clicks": true,
- "opens": true,
- "unsubscribe": true
}, - "dnsRecords": [
- {
- "recordType": "string",
- "name": "string",
- "expectedValue": "string",
- "verified": true
}
], - "blocked": false,
- "createdAt": "2021-01-02T01:00:00.123Z",
- "returnPathAddress": "returnpath@example.com"
}
]
}
Need assistance
Encountering issues
What's new? Check out
Unsure about a term? See