Sign in
MailcowOrder

List order

get/v1beta/mailcow/orders

Query parameters

limitinteger

Search query limit.

offsetinteger

Search query offset.

order_by.idstring

desc/asc.

order_by.created_atstring

desc/asc.

order_by.expired_atstring

desc/asc.

order_by.mailbox_statusstring

desc/asc.

statusstring[]

Array of order statuses.

domain.namestring

Domain name without extension.

domain.extensionstring

Domain extension.

mailboxstring

Name mailbox.

mailbox_statusstring[]

Array of mailbox status in the MailCow.

Response

A successful response.

codeinteger
descstring
maintenanceboolean

Example response

{
  "code": 0,
  "data": {
    "results": [
      {
        "created_at": "2019-01-01 0:00:01",
        "domain": {
          "extension": "london",
          "name": "test4"
        },
        "expired_at": "2019-01-01 0:00:01",
        "id": 123456789,
        "mailbox": "",
        "mailbox_status": "",
        "owner_handle": "XX123456-XX",
        "quota": 15,
        "quota_used": 10,
        "renew_at": "2019-01-01 0:00:01",
        "status": "",
        "subscription_period": 1
      }
    ],
    "total": 999
  },
  "desc": ""
}

Changes