Domains

List domains

Returns a paginated list of domains for the authenticated client.

Filtering

  • search: Filter by domain name (partial match)
  • status: Filter by status. Valid values: active, inactive, pending, in_progress
  • tag_ids: Filter by tag IDs (comma-separated)
  • is_warmup: Filter by warmup status

Sorting

  • sort: Order by creation date. Valid values: latest or oldest (default: latest)
  • Invalid sort values will be rejected with a validation error

Pagination

  • offset: Number of items to skip (default: 0)
  • limit: Maximum items to return (default: 20, max: 100)

Response

Each domain includes:

  • Basic domain information
  • Active nameservers
  • DNS provider details
  • Associated tags (if requested with include_tags=true)
  • Mailboxes (if requested with include_mailboxes=true)

Note: Tag filtering via tag_ids works regardless of the include_tags flag. When include_tags=false, tags are not included in the response but filtering still applies.

get/api/v1/domains

Request

  • Base URL: https://api.aerosend.io
  • URL: https://api.aerosend.io/api/v1/domains
  • Auth: API key in header X-API-Key

Query parameters

offsetinteger

Number of items to skip

limitinteger

Maximum items to return (1-100)

sort'latest' | 'oldest'

Sort order

searchstring

Search by domain name

status'active' | 'inactive' | 'pending' | 'in_progress'
Example:active

Filter by status. Valid values: active, inactive, pending, in_progress

tag_idsinteger[]

Filter by tag IDs (comma-separated)

is_warmupboolean

Filter by warmup status

include_mailboxesboolean

Include mailboxes in response

include_tagsboolean

Include tags in response. Tag filtering still works regardless of this flag.

Response

Successfully retrieved domains

successboolean

Success flag

timestampstring

Response timestamp

Example response

{
  "success": true,
  "data": [
    {
      "id": 123,
      "domain_tld": "example.com",
      "mail_domain": "mail",
      "status": "active",
      "is_warmup": true,
      "warmup_start_date": "2025-12-01T00:00:00Z",
      "warmup_end_date": "2025-12-22T00:00:00Z",
      "mailbox_count": 5,
      "redirect_url": "https://example.com",
      "attached_at": "2025-11-01T10:30:00Z",
      "dns_provider": {
        "id": 1,
        "name": "Cloudflare"
      },
      "mailboxes": [
        {
          "id": 456,
          "email": "john@example.com",
          "first_name": "John",
          "last_name": "Doe",
          "status": "active",
          "created_at": "2025-12-01T10:30:00Z",
          "updated_at": "2025-12-10T15:45:00Z",
          "domain_id": 123,
          "domain": "example.com",
          "credentials": {
            "smtp": {
              "host": "smtp.topdeliverabilityninja.com",
              "port": 587,
              "username": "john@example.com",
              "security": "TLS"
            },
            "imap": {
              "host": "smtp.topdeliverabilityninja.com",
              "port": 587,
              "username": "john@example.com",
              "security": "TLS"
            }
          },
          "tags": [
            {
              "id": 789,
              "name": "client-abc",
              "display_name": "Client ABC",
              "color": "#000369",
              "status": "active",
              "domain_count": 10,
              "mailbox_count": 45,
              "created_at": "2025-12-01T10:30:00Z",
              "updated_at": "2025-12-10T15:45:00Z"
            }
          ]
        }
      ],
      "tags": [
        {
          "id": 789,
          "name": "client-abc",
          "display_name": "Client ABC",
          "color": "#000369",
          "status": "active",
          "domain_count": 10,
          "mailbox_count": 45,
          "created_at": "2025-12-01T10:30:00Z",
          "updated_at": "2025-12-10T15:45:00Z"
        }
      ]
    }
  ],
  "pagination": {
    "limit": 20,
    "total": 150,
    "has_more": true
  },
  "timestamp": "2025-12-14T10:30:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.