Skip to navigation
API ReferenceSubaccounts

Get subaccount information

Retrieve detailed information about a specific subaccount including sending statistics and configuration.

Request

This endpoint expects an object.
keystringRequired
A valid Mandrill API key
idstringRequired
The unique identifier of the subaccount to query

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
sent_hourlyinteger
Number of emails the subaccount has sent in the last hour
hourly_quotainteger

Current hourly quota for the subaccount, either manual or reputation-based

notesstring
Optional extra text to associate with the subaccount
last_30_daysobject
Sending statistics for this subaccount in the last 30 days
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
404
Not Found Error
500
Internal Server Error