subaccounts
Get Subaccounts lists information
List subaccounts information
get/subaccounts/list
Query parameters
pageinteger nullable
Page number. Must be an integer greater than 0.
Example:1
Page number
limitinteger nullable
The number of rows per page to return. Must be an integer greater than 0.
Example:10
The numbers of rows per page to return
filter_by_emailstring
Filter by email addresses that fully/partially match the search value.
Example:Jhon
Filter by email addresses that fully/partially match the search value.
filter_by_activeboolean
Filter by subaccount active/inactive status (true=active, false=inactive).
Example:true
Filter by subaccount active/inactive status. Accepts boolean values (true or false).
filter_by_ip[]string[]
Filter by IPv4 addresses. Multiple IPs can be provided. Valid IPv4 format (e.g., 192.168.1.1).
Filter by IPv4 addresses (e.g., 192.168.1.1). Multiple IPs can be provided.
order_by'email' | 'last_used'
Field to sort by
Example:email
Field to sort by
ordertype'asc' | 'desc'
Order Ascending or Descending.
Example:desc
Response
Sucess
Subaccounts list.
Example response
{
"count": 2,
"results": [
{
"active": true,
"email": "subaccount-1@yourdomain.om",
"subaccount_id": 19302132,
"parent_id": 22190623,
"ip": "199.244.75.250",
"last_used": "2022-11-20 22:44:07",
"limit": 16,
"plan_expiration": "2023-01-17 00:00:00",
"sent": 2,
"plan_limit_interval": "Monthly",
"expired": false
},
{
"active": true,
"email": "subaccount-2@yourdomain.om",
"subaccount_id": 19302133,
"parent_id": 22190623,
"ip": "199.244.75.250",
"last_used": "2022-11-19 21:04:07",
"limit": 50,
"plan_expiration": "2023-01-17 00:00:00",
"sent": 34,
"plan_limit_interval": "Monthly",
"expired": false
}
]
}