GET
/domainsRetrieve a list of domainsParameters
limitintegerqueryNumber of items to return.
afterstringqueryReturn items after this cursor.
beforestringqueryReturn items before this cursor.
Responses
objectListDomainsResponse
dataarray of objectShow child attributes
Show array items
capabilitiesobjectConfigure the domain capabilities for sending and receiving emails. At least one capability must be enabled.
Show child attributes
receivingstringEnable or disable receiving emails to this domain.
sendingstringEnable or disable sending emails from this domain.
created_atstring · date-timeThe date and time the domain was created.
idstringThe ID of the domain.
namestringThe name of the domain.
regionstringThe region where the domain is hosted.
statusstringThe status of the domain.
has_morebooleanIndicates if there are more results available.
objectstringType of the response object.
{
"data": [
{
"capabilities": {
"receiving": "disabled",
"sending": "disabled"
},
"created_at": "2023-04-26T20:21:26.347412+00:00",
"id": "d91cd9bd-1176-453e-8fc1-35364d380206",
"name": "example.com",
"region": "us-east-1",
"status": "not_started"
}
],
"has_more": false,
"object": "list"
}