---
title: "Get sub-accounts"
method: GET
path: "/account/{AccountIdentifier}/program/{ProgramCode}/subaccounts"
tags: ["Account"]
---

# Get sub-accounts

`GET /account/{AccountIdentifier}/program/{ProgramCode}/subaccounts`

## Request

- Base URL: `https://sandbox.preprod.connect.xpansiv.com/app/api/v1`
- URL: `https://sandbox.preprod.connect.xpansiv.com/app/api/v1/account/{AccountIdentifier}/program/{ProgramCode}/subaccounts`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/xpansiv/apis/xpansiv-connect-api/docs/account/:AccountIdentifier/program/:ProgramCode/subaccounts/get.ts> (a function with typed inputs; its response is checked against the schema)

Get sub-accounts for a given account and program

## Path parameters

- `AccountIdentifier` string, required
- `ProgramCode` string, required: Ref.Data.PROGRAM

## Response `200`

List of sub-accounts

- object[]
  - `code` string, required: Unique identifier.
  - `name` string, required: Name of the Sub-Account in the registry.
  - `subAccountType` string, required: Type of registry sub-account. Ref.Data.SUBACCOUNT_REGISTRY_TYPE
  - `active` boolean, required: True/False.
  - `public` boolean, required: True/False.
  - `complianceStatus` string: Flag for whether sub-account is for compliance retirement activity. Ref.Data.COMPLIANCE_STATUS

## Other responses

- `400`: Bad request
- `401`: Not authorized error
- `500`: Internal server error

---

[API](https://skmtc.dev/xpansiv/apis/xpansiv-connect-api.md) - [All operations](https://skmtc.dev/xpansiv/apis/xpansiv-connect-api/llms.txt) - [OpenAPI document](https://skmtc.dev/xpansiv/apis/xpansiv-connect-api/revisions/01c1f2c4ec1e?raw)