Skip to navigation
API ReferenceSubaccounts

List subaccounts

Get the list of subaccounts defined for the account, optionally filtered by a prefix. Returns up to a maximum of 1,000 subaccounts.

Request

This endpoint expects an object.
keystringRequired
A valid Mandrill API key
qstringOptional
An optional prefix to filter the subaccounts' ids and names

Response

Success
idstring<=255 characters
Unique identifier for the subaccount
created_atstringformat: "^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$"

Date and time the subaccount was created in UTC YYYY-MM-DD HH:MM:SS format

statusenum
Current sending status of the subaccount
Allowed values:
reputationinteger<=100
Subaccount reputation on a scale from 0 to 100
sent_weeklyinteger

Number of emails the subaccount has sent so far this week (weeks start on midnight Monday, UTC)

sent_monthlyinteger

Number of emails the subaccount has sent so far this month (months start on midnight of the 1st, UTC)

sent_totalinteger
Number of emails the subaccount has sent since it was created
namestringOptional<=255 characters
Optional display name for the subaccount
first_sent_atstring or nullOptionalformat: "^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$"

Date and time that the subaccount first sent as a UTC string in YYYY-MM-DD HH:MM:SS format

custom_quotaintegerOptional>=1

Optional manual hourly quota for the subaccount. Only present when explicitly set during creation/update

Errors

401
Unauthorized Error
500
Internal Server Error