maildomains

GET /api/v1.0/maildomains/

Changed on

List mail domains, optionally filtered by name with the q parameter.

Request

  • The document declares no server URL.
  • Auth
    API key in cookie sessionid

Query parameters

pageinteger

A page number within the paginated result set.

qstring

Filter domains whose 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"
}

Changes

    • breaking

      the response property // became nullable for the status

    • breaking

      the // response's property type changed from string to array for status

    • info

      added the new optional query request parameter q

    • info

      added the required property // to the response with the status