List Users
On this page
http
GET /cranemail/domains/{domain}/users
disk_limit is the mailbox’s own quota in MB, 0 when it shares the domain’s. The mail server reports usage only as a share of a mailbox’s own quota, so disk_usage (MB) is null for a mailbox without one.
Query Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| search | string | No | Filter by mailbox name |
| offset | integer | No | Skip this many |
| limit | integer | No | Return at most this many (1-1000). Default: all |
Response
json
{
"users": [
{
"username": "john",
"display_name": "John Doe",
"admin": false,
"primary_admin": false,
"enabled": true,
"disk_usage": 500.25,
"disk_limit": 0
}
],
"total": 1
}