---
title: "Get Subaccounts lists information"
method: GET
path: "/subaccounts/list"
tags: ["subaccounts"]
---

# Get Subaccounts lists information

`GET /subaccounts/list`

## Request

- Base URL: `https://pro.api.serversmtp.com/api/v2`
- URL: `https://pro.api.serversmtp.com/api/v2/subaccounts/list`
- Auth: one of:
  - API key in header `Authorization`
  - API key in header `consumerKey` and API key in header `consumerSecret`

List subaccounts information

## Query parameters

- `page` integer, nullable: Page number. Must be an integer greater than 0.
- `limit` integer, nullable: The number of rows per page to return. Must be an integer greater than 0.
- `filter_by_email` string: Filter by email addresses that fully/partially match the search value.
- `filter_by_active` boolean: Filter by subaccount active/inactive status (true=active, false=inactive).
- `filter_by_ip[]` string[]: Filter by IPv4 addresses. Multiple IPs can be provided. Valid IPv4 format (e.g., 192.168.1.1).
- `order_by` 'email' | 'last_used': Field to sort by
- `ordertype` 'asc' | 'desc': Order Ascending or Descending.

## Response `200`

Sucess

Subaccounts list.

- SubAccountListSucessResponsetBody
  - `count` integer
  - `results` SubaccountListItem[]
    - `email` string, email, required
    - `ip` string: IP address to use for sending emails.
    - `active` boolean, required: Active subaccounts can be used for login purpose, while users can´t login to inactive subaccounts. Notice that in order to be able to send emails the subaccount subscription must also be active. User can set subaccounts to active / inactive from the dashboard.
    - `subaccount_id` integer: Sub account Id
    - `parent_id` integer: Sub account parent Id
    - `limit` integer, required: The ammount of emails the sub account is allowed to send over the period specified by plan_limit_interval. Value -1 means no limit.
    - `sent` integer: The ammount of sent emails from the sub account over the current period.
    - `last_used` string, nullable
    - `plan_expiration` string, nullable
    - `plan_limit_interval` 'Daily' | 'Monthly' | 'Yearly': Limit interval that specifies if the sub account sending limit is specified daily, monthly or yearly. * Important Note: The limit interval allways follows the main account limit.
    - `expired` boolean: Expired if plan expiration date is overdue.

## Other responses

- `400`: Bad Request ###### Produces: * page_should_be_integer * page_should_be_greater_than_0 * limit_should_be_integer * limit_should_be_greater_than_0 * filter_by_active_should_be_boolean * ip_should_be_IPV4_format * order_by_can_only_be_email_or_last_used * ordertype_should_be_asc_or_desc
- `401`: Unauthorized This API requires a valid API Key to be provided. (Use [/authentication/authorize](#/authentication/AuthenticationLogin) to obtain an API Key) Produces: * missing_authorization_key * invalid_authorization_key * account_is_inactive
- `403`: Forbidden The current active plan does not include this feature, upgrade is required to use this feature.
- `404`: Not Found Page not found.

---

[API](https://skmtc.dev/serversmtp/apis/turbosmtp-public-apis.md) - [All operations](https://skmtc.dev/serversmtp/apis/turbosmtp-public-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/serversmtp/apis/turbosmtp-public-apis/revisions/8503e099b215?raw)