v1

latestOpenAPI 3.0.02026-08-04134348905.1 KB

Subaccounts

List all subaccounts

Permissions required: Subaccount

Return all subaccounts associated for an organization

get/subaccounts/customers/accounts

Query parameters

subaccountIdsstring[]

Array of Unique Identifiers for the subaccount

externalIdsstring[]

Array of Unique Identifiers within an external system

endDatestring date

The end date (inclusive) in YYYY-MM-DD format. The latest valid end date is the current date. Dates are always in UTC RFC 3339 'full-date'.

afterIdstring

When paginating this is used to provide the starting point for the page to fetch (retrieved from the previous response body)

statusesstring[]

Filter subaccounts by status

limitinteger

Maximum number of results to return per query

Response

Successfully returned subaccounts

Example response

{
  "data": [
    {
      "accruedFees": [
        {
          "startPeriod": "2024-06-01",
          "endPeriod": "2024-06-15",
          "accruedValue": "1.21",
          "rate": 0.01,
          "type": "MANAGEMENT",
          "totalBalanceInUSD": "121.33",
          "state": "ONGOING"
        },
        {
          "startPeriod": "2024-05-01",
          "endPeriod": "2024-05-31",
          "accruedValue": "1.12",
          "rate": 0.01,
          "type": "MANAGEMENT",
          "totalBalanceInUSD": "112.33",
          "state": "DONE"
        },
        {
          "startPeriod": "2024-04-01",
          "endPeriod": "2024-04-30",
          "accruedValue": "1.21",
          "rate": 0.01,
          "type": "MANAGEMENT",
          "totalBalanceInUSD": "121.33",
          "state": "DONE"
        },
        {
          "startPeriod": "2024-06-01",
          "endPeriod": "2024-06-15",
          "accruedValue": "1.21",
          "rate": 0.01,
          "type": "MODEL",
          "totalBalanceInUSD": "121.33",
          "state": "ONGOING"
        },
        {
          "startPeriod": "2024-05-01",
          "endPeriod": "2024-05-31",
          "accruedValue": "1.21",
          "rate": 0.01,
          "type": "MODEL",
          "totalBalanceInUSD": "121.33",
          "state": "DONE"
        },
        {
          "startPeriod": "2024-04-01",
          "endPeriod": "2024-04-30",
          "accruedValue": "1.21",
          "rate": 0.01,
          "type": "MODEL",
          "totalBalanceInUSD": "121.33",
          "state": "DONE"
        }
      ],
      "balances": [
        {
          "assetType": "BTC"
        }
      ],
      "createdAt": "2019-01-02T12:34:56.000Z",
      "fees": [
        {
          "type": "ADVISORY",
          "rate": 0.01,
          "startDate": "2023-08-01",
          "isBillable": true
        },
        {
          "type": "MODEL",
          "rate": 0.01,
          "startDate": "2023-08-01",
          "isBillable": true
        },
        {
          "type": "MANAGEMENT",
          "rate": 0.01,
          "startDate": "2023-08-01",
          "isBillable": true
        },
        {
          "type": "CUSTODY",
          "rate": 0.01,
          "startDate": "2023-08-01",
          "isBillable": true
        }
      ],
      "subaccountId": "ec761b5e-fd2c-497a-a9a0-f8738ac97bdf"
    }
  ],
  "page": {
    "next": "<next page url>"
  }
}