List Accounts

Returns a list of domains.

smtppy.listaccounts(address, isActive, page)

Parameters

• isActive (boolean) - Filter by active status

• page (int) - The collection page number

• address (string) - Filter by account address

Response

{
  "member": [
    {
      "id": "string",
      "address": "[e-mail]",
      "quota": 0,
      "used": 0,
      "isActive": true,
      "isDeleted": false,
      "createdAt": "2025-04-01T00:00:00.000Z",
      "updatedAt": "2025-04-01T00:00:00.000Z"
    }
  ],
  "totalItems": 0,
  "view": {
    "id": "string",
    "type": "string",
    "first": "string",
    "last": "string",
    "previous": "string",
    "next": "string"
  },
  "search": {
    "type": "string",
    "template": "string",
    "variableRepresentation": "string",
    "mapping": [
      {
        "type": "string",
        "variable": "string",
        "property": "string",
        "required": true
      }
    ]
  }
}

Want to learn about writing content from scratch? Head to the Basics section to learn more.