v5

latestOpenAPI 3.0.0MIT2026-08-041554551.6 MB

Domains

List domains for an environment

Returns a paginated list of inbound-email domains in the current environment. Supports cursor pagination and a name contains filter.

get/v1/domains

Query parameters

afterstring

Cursor for pagination indicating the starting point after which to fetch results.

beforestring

Cursor for pagination indicating the ending point before which to fetch results.

limitnumber

Limit the number of items to return

orderDirection'ASC' | 'DESC'

Direction of sorting

orderBystring

Field to order by

includeCursorboolean

Include cursor item in response

namestring

Domain name to filter results by.

Response

nextstring nullable required

The cursor for the next page of results, or null if there are no more pages.

previousstring nullable required

The cursor for the previous page of results, or null if this is the first page.

totalCountnumber required

The total count of items (up to 50,000)

totalCountCappedboolean required

Whether there are more than 50,000 results available

Example response

{
  "data": [
    {
      "expectedDnsRecords": [
        {
          "type": "MX",
          "name": "inbound",
          "content": "inbound-smtp.us-east-1.amazonaws.com",
          "ttl": "Auto",
          "priority": 10
        }
      ]
    }
  ]
}