v51

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-01121113461.4 KB
maildomains

List mailboxes, optionally filtered by local part / contact name.

get/api/v1.0/maildomains/{maildomain_pk}/mailboxes/

Path parameters

maildomain_pkstring uuid required

Query parameters

pageinteger

A page number within the paginated result set.

qstring

Filter mailboxes whose local part or contact name contains this value (case-insensitive).

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}