List Domains
List the account's domains with basic statistics, paginated.
List the account's domains with basic sending statistics. Results are paginated and can be searched and sorted.
Scope: domains.read
Query Parameters
searchstringoptionalOptional search term to filter domains by name.
pageintegeroptionalPage number (minimum 1).
per_pageintegeroptionalItems per page (minimum 10, maximum 100).
sort_bystringoptionalSort field: id, domain_name, delivered, bounced, opened, or clicked.
sort_dirstringoptionalSort direction: asc or desc.
Response
domainsarrayoptionalList of domain objects, each with id, domain_name, statistics (delivered, bounced, opened, clicked), and status.
totalintegeroptionalTotal number of domains.
pageintegeroptionalCurrent page.
per_pageintegeroptionalPage size.
total_pagesintegeroptionalTotal number of pages.
Sample Response
200 OK
{
"data": {
"domains": [
{
"id": 123,
"domain_name": "example.com",
"statistics": {
"delivered": 100,
"bounced": 2,
"opened": 60,
"clicked": 18
},
"status": true
}
],
"total": 1,
"page": 1,
"per_page": 25,
"total_pages": 1
}
}