---
title: "List Sub Accounts"
method: GET
path: "/v1/master/list_sub"
tags: ["Master API"]
---

# List Sub Accounts

`GET /v1/master/list_sub`

## Request

- Base URL: `http://{{base_url}}`
- URL: `http://{{base_url}}/v1/master/list_sub`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/extensiv/apis/integration-manager-api-formerly-cartrover/docs/v1/master/list_sub/get.ts> (a function with typed inputs; its response is checked against the schema)

Get a list of all Sub Accounts

**Note:** Any filters should be passed with the URL as GET arguments. 
### Filters
|    Argument    |    Description    |
|----------------|-----------------------------------------------------------------|
|    include_discontinued    |    N or Y. Default N. If Y, accounts that have been discontinued will be returned as well    |

### Response Fields
|     Field      |     Data Type         |     Length      |     Description         |
|-------------------|-----------------------|-----------------|----------------------------------|
|    warehouses    |    Array    |        |   List of Warehouse sub-accounts    |
|    merchants    |    Array    |        |    List of Merchant sub-accounts    |

#### warehouses Fields
warehouses is a numerically indexed array with each element containing the following keys.

|     Field      |     Data Type         |     Length      |     Description         |
|-------------------|-----------------------|-----------------|----------------------------------|
|    fclient_pk    |    Int    |        |   CartRover warehouse ID    |
|    company    |    String    |        |    Warehouse Company Name    |
|    discontinued_sw    |    String    |        |    Y or N. Y for disabled.    |

#### merchants Fields
merchants is a numerically indexed array with each element containing the following keys.

|     Field      |     Data Type         |     Length      |     Description         |
|-------------------|-----------------------|-----------------|----------------------------------|
|    merchant_pk    |    Int    |        |   CartRover merchant ID    |
|    company    |    String    |        |    Merchant Company Name    |
|    discontinued_sw    |    String    |        |    Y or N. Y for disabled.    |

## Response `200`

OK

- object

---

[API](https://skmtc.dev/extensiv/apis/integration-manager-api-formerly-cartrover.md) - [All operations](https://skmtc.dev/extensiv/apis/integration-manager-api-formerly-cartrover/llms.txt) - [OpenAPI document](https://skmtc.dev/extensiv/apis/integration-manager-api-formerly-cartrover/revisions/125e6deac675?raw)