Return to Homepage

List Services

http
GET /cranemail/services

Returns the client’s reseller CraneMail services, with each domain’s usage. Scoped keys only see services they have access to. login_hostnames are the service’s own addresses for the workspace.org sign-in page that are live (set up under Login Portal); show one of them to your customers in place of workspace.org.

Response

json
[
  {
    "id": 12,
    "name": "CraneMail Reseller",
    "status": "active",
    "domain_limit": 50,
    "domain_count": 2,
    "login_hostnames": ["webmail.example.net"],
    "domains": [
      { "domain": "example.com", "status": "active", "verified": true, "disk_limit": 10, "disk_usage": 2450.5, "user_limit": 50, "user_count": 12 },
      { "domain": "example.org", "status": "pending", "verified": false, "disk_limit": 5, "disk_usage": 0, "user_limit": 10, "user_count": 0 }
    ]
  }
]

On this page

Snagged on something?

Our sysadmins answer tickets around the clock.