Skip to main content
GET
/
account
/
subaccount
/
Get All Sub-Accounts
curl --request GET \
  --url https://api.sendpost.io/api/v1/account/subaccount/ \
  --header 'X-Account-ApiKey: <api-key>'
[
  {
    "id": 11,
    "name": "Hooli",
    "created": 1567512491586102000,
    "apiKey": "AHZ3125333JHEP",
    "labels": [
      "label1",
      "label2"
    ],
    "isPlus": true,
    "type": 1,
    "createdBy": {
      "id": 117,
      "isVerified": true,
      "isForbidden": false,
      "email": "raj@piedpiper.com",
      "name": "Raj",
      "logoURL": "https://www.sendpost.io/logo.png",
      "companyName": "SendPost",
      "onboardQAnswered": true,
      "phoneNumber": "+919876543210",
      "created": 1567512491588004000,
      "updated": 1567512491588004000
    },
    "updatedBy": {
      "id": 117,
      "isVerified": true,
      "isForbidden": false,
      "email": "raj@piedpiper.com",
      "name": "Raj",
      "logoURL": "https://www.sendpost.io/logo.png",
      "companyName": "SendPost",
      "onboardQAnswered": true,
      "phoneNumber": "+919876543210",
      "created": 1567512491588004000,
      "updated": 1567512491588004000
    },
    "smtpAuths": [
      {
        "id": 117,
        "username": "default@117.sendpost.io",
        "password": "default@117.sendpost.io",
        "created": 1567512491588004000,
        "updated": 1567512491588004000
      }
    ]
  }
]

Authorizations

​
X-Account-ApiKey
string
header
required

This api key can be used for all account level operations

Query Parameters

​
limit
integer

Number of records to return per request.

Example:

10

​
offset
integer

Number of initial records to skip.

Example:

0

​
search
string

Case-insensitive search against the sub-account name.

Example:

"Hooli"

Response

Successfully retrieved sub-accounts.

​
id
integer

Unique ID for the sub-account.

Example:

11

​
name
string

Name of the sub-account.

Example:

"Hooli"

​
created
integer

UNIX epoch nano timestamp when the sub-account was created.

Example:

1567512491586102000

​
apiKey
string

API key for the sub-account.

Example:

"AHZ3125333JHEP"

​
labels
string[]

Labels associated with the sub-account

Example:
["label1", "label2"]
​
isPlus
boolean

Indicates whether the sub-account is a Plus sub-account

Example:

true

​
type
enum<integer>

Type of the sub-account

Available options:
0,
1
Example:

1

​
createdBy
object

Member who created the sub-account

​
updatedBy
object

Member who updated the sub-account

​
smtpAuths
object[]

SMTP Auths associated with the sub-account

⌘I