Connected Accounts

Get connected accounts

Returns all connected accounts.

get/connected_accounts

Request

Query parameters

mainAccountsboolean

Whether to include only main accounts in the response.

pageSizeinteger

Page size for pagination.

pageCursorstring

Page cursor for pagination.

Response

Get accounts response

totalinteger

Total number of accounts by query.

nextstring

A cursor for the next page of results, if available.

Example response

{
  "data": [
    {
      "id": "acc-123456",
      "name": "Main Venue Account",
      "providerId": "BRIDGE",
      "status": "APPROVED",
      "totalBalance": {
        "amount": "1201.15",
        "denominatedAssetId": "ea6c3cb7-355a-4ee3-82ff-267c69970214",
        "hasFullAssetCoverage": true
      },
      "manifest": {
        "assetTypes": [],
        "capabilities": [
          "DEPOSITS",
          "WITHDRAWALS"
        ]
      },
      "accountType": "CONNECTED_ACCOUNT"
    },
    {
      "id": "acc-654321",
      "name": "Secondary Account",
      "providerId": "BRIDGE",
      "status": "WAITING_FOR_APPROVAL",
      "totalBalance": {
        "amount": "0.00",
        "denominatedAssetId": "ea6c3cb7-355a-4ee3-82ff-267c69970214",
        "hasFullAssetCoverage": false
      },
      "manifest": {
        "assetTypes": [],
        "capabilities": [
          "WITHDRAWALS"
        ]
      },
      "accountType": "CONNECTED_ACCOUNT"
    }
  ],
  "total": 2,
  "next": "eyJwYWdlIjoyfQ=="
}

Changes

No recorded changes to this operation across all 1 revision of this API.