GET sub-accounts

Prev Next

FTP Deprecation

On May 1, 2025, Wasabi deprecated support for FTP. Learn more by reviewing FTP Deprecation.

Get Sub-Accounts

Returns a list of all Sub-Accounts associated with the Governance Account or Control Account.

URL (GET)

/api/v1/sub-accounts

Parameters

pageList page number
sizeList page size
idFilter by account id
nameFilter by account name
controlAccountIdFilter by controlAccountId
governanceAccountIdFilter by governanceAccountId
statusFilter by account status ON_TRIAL, PAID_ACCOUNT, SUSPENDED
wasabiAccountNameFilter by wasabiAccountName
wasabiAccountNumberFilter by wasabiAccountNumber
includeDeleted: true/falseIf set to true, includes deleted accounts on the response list
includeKeys: true/falseIf set to true, includes the access and secret keys of the sub-account on the response

Request Body

None

Response

{
    "success": true,
    "message": "Successfully read!",
    "data": {
        "items": [
            {
                "id": 93,
                "name": "example@example.com",
                "category": null,
                "partnerType": "CUSTOMER",
                "accountType": "Company",
                "status": "PAID_ACCOUNT",
                "imageUrl": null,
                "creationDate": "2020-09-14T07:05:09.000Z",
                "address1": "100 Test Rd",
                "address2": null,
                "country": "United States",
                "city": "Hillsboro",
                "state": "Arizona",
                "zip": "97003",
                "mainPhone": "(208) 876-7876",
                "billingPhone": "(206) 787-8987",
                "contactEmail": "example@example.com",
                "billingEmail": "example@example.com",
                "businessNumber": null,
                "taxId": null,
                "fiscalNumber": null,
                "vatNumber": null,
                "website": null,
                "controlAccountId": 3910,
                "controlAccountName": "Control Account Example",
                "controlAccountEmail": null,
                "governanceAccountId": null,
                "governanceAccountName": null,
                "wasabiAccountNumber": "218308",
                "wasabiAccountName": "example@example.com",
                "sendPasswordResetToSubAccount": false,
                "ftpEnabled": true,
                "activeStorage": 0.00488281252,
                "deletedStorage": 0,
                "trialQuota": null,
                "trialExpiration": null
            },
            {
                "id": 94,
                "name": "example@example.com",
                "category": null,
                "partnerType": "CUSTOMER",
                "accountType": "Company",
                "status": "PAID_ACCOUNT",
                "imageUrl": null,
                "creationDate": "2020-09-14T07:06:45.000Z",
                "address1": null,
                "address2": null,
                "country": null,
                "city": null,
                "state": null,
                "zip": null,
                "mainPhone": null,
                "billingPhone": null,
                "contactEmail": "example@example.com",
                "billingEmail": null,
                 "businessNumber": null,
                "taxId": null,
                "fiscalNumber": null,
                "vatNumber": null,
                "website": null,
                "controlAccountId": 3910,
                "controlAccountName": "Control Account Example",
                "controlAccountEmail": null,
                "governanceAccountId": null,
                "governanceAccountName": null,
                "wasabiAccountNumber": "218309",
                "wasabiAccountName": "example@example.com",
                "sendPasswordResetToSubAccount": true,
                "ftpEnabled": true,
                "activeStorage": 0.00488281253,
                "deletedStorage": 0,
                "trialQuota": null,
                "trialExpiration": null
            },