---
title: "List Sub Accounts"
method: GET
path: "/sub_accounts"
tags: ["Sub Accounts"]
---

# List Sub Accounts

`GET /sub_accounts`

## Request

- Base URL: `https://api.justifi.ai/v1`
- URL: `https://api.justifi.ai/v1/sub_accounts`
- Auth: none declared. Required headers: `Authorization`
- TypeScript: <https://skmtc.dev/justifi/apis/justifi-api-documentation/docs/sub_accounts/get.ts> (a function with typed inputs; its response is checked against the schema)

List the sub accounts for your platform. This endpoint supports [pagination](https://docs.justifi.tech/api-spec#section/Pagination).
*Note: By default, all sub accounts which are not archived will be returned. To list archived sub accounts, use the optional status parameter set to `archived`*

## Query parameters

- `status` 'created' | 'submitted' | 'information_needed' | 'rejected' | 'enabled' | 'disabled' | 'archived'
- `business_id` string

## Headers

- `Authorization` string, required

## Response `200`

Successfully list sub accounts

- object
  - `id` number: the object id
  - `type` string: the object type, or array of objects
  - `data` SubAccount[]: the list of objects
    - `id` string, uuid: sub account id
    - `name` string: sub account name
    - `account_type` string: sub account type (live or test)
    - `status` 'created' | 'submitted' | 'information_needed' | 'rejected' | 'enabled' | 'disabled' | 'archived': sub account status
    - `currency` 'usd' | 'cad'
    - `platform_account_id` string, uuid: id of associated platform account
    - `platform_sub_account` boolean: true if this is the platform's own sub account, the one the platform uses to take payments as a business itself (one per mode, live and test); false for every other sub account
    - `payout_account_id` string, uuid: id of active payout bank account
    - `business_id` string, uuid: id of associated business
    - `application_fee_rates` unknown[]: list of associated application fee rates
      - unknown
    - `processing_ready` boolean: sub account ready for processing
    - `payout_ready` boolean: sub account ready for payouts
    - `related_accounts` object: when a live sub account is created, a related test account is automatically created; this provides both ids
      - `live_account_id` string, uuid: live sub account id (this will be nil if a sub account was created with test credentials)
      - `test_account_id` string, uuid: test sub account id
    - `payments_activated_on` string, date-time, nullable: date and time when the first successful payment was processed on this sub account
    - `created_at` string, date-time
    - `updated_at` string, date-time
  - `page_info` PageInfo
    - `end_cursor` string: the encoded id of the last record in the current list
    - `has_next` boolean: true if the collection contains records following the current list
    - `has_previous` boolean: true if the collection contains records ahead of the current list
    - `start_cursor` string: the encoded id of the first record in the current list

---

[API](https://skmtc.dev/justifi/apis/justifi-api-documentation.md) - [All operations](https://skmtc.dev/justifi/apis/justifi-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/justifi/apis/justifi-api-documentation/revisions/dd9f3fed7e46?raw)