Get the list of subaccounts defined for the account, optionally filtered by a prefix
Signature
public function getList([string
$q = NULL] )
Parameters
$q
—
string
an optional prefix to filter the subaccounts' ids and names
Returns
array
the subaccounts for the account, up to a maximum of 1,000 - return[] struct the individual subaccount info
- id string a unique indentifier for the subaccount
- name string an optional display name for the subaccount
- custom_quota integer an optional manual hourly quota for the subaccount. If not specified, the hourly quota will be managed based on reputation
- status string the current sending status of the subaccount, one of "active" or "paused"
- reputation integer the subaccount's current reputation on a scale from 0 to 100
- created_at string the date and time that the subaccount was created as a UTC string in YYYY-MM-DD HH:MM:SS format
- first_sent_at string the date and time that the subaccount first sent as a UTC string in YYYY-MM-DD HH:MM:SS format
- sent_weekly integer the number of emails the subaccount has sent so far this week (weeks start on midnight Monday, UTC)
- sent_monthly integer the number of emails the subaccount has sent so far this month (months start on midnight of the 1st, UTC)
- sent_total integer the number of emails the subaccount has sent since it was created