# List Accounts & Balances

**GET** `/users/{user_id}/accounts`

Base URL: `https://live.savewithsail.com/api/v1`

Accounts across all of the user's connections. Requires the `benefit_account` key scope. Balances require the `benefit_account` product on the owning connection.

## Authorization

- PartnerKey (http, bearer)

## Path parameters

- `user_id` (string, required)
  The Sail user id.

## Query parameters

- `connection_id` (string)
  Restrict to accounts under one connection.
- `type` (string)
  Filter to accounts of one type.
- `limit` (integer)
  Max results per page.
- `offset` (integer)
  Pagination offset.

## Responses

### 200

The user's accounts.

- `data` (object[])
  - `id` (string)
    The Sail account id.
  - `connection_id` (string)
    The connection this account belongs to.
  - `external_id` (string)
    The administrator's identifier for this account.
  - `name` (string)
    The account's display name.
  - `type` ("hsa" | "fsa" | "hra" | "checking" | "savings" | "credit_card")
    The account type.
  - `start_date` (string<date>)
    When the account became effective.
  - `end_date` (string<date>)
    Plan-year end for plan-bound accounts (FSA); null for HSAs, which have no end date.
  - `balance` (object)
    Present only when the owning connection has the `benefit_account` product.
    - `cash` (number<float>)
      Cash balance available.
    - `invested` (number<float>)
      Invested balance, if the account supports investments. Null otherwise.
  - `last_sync_at` (string<date-time>)
    When this account's data was last synced. Null if it has never synced.
- `pagination` (object)
  Pagination metadata for this page.
  - `total` (integer)
    Total number of matching records, across all pages.
  - `limit` (integer)
    The `limit` used for this page.
  - `offset` (integer)
    The `offset` used for this page.
  - `has_more` (boolean)
    Whether additional pages remain after this one.

Example:

```json
{
  "data": [
    {
      "id": "acct_77b1",
      "connection_id": "string",
      "external_id": "string",
      "name": "string",
      "type": "hsa",
      "start_date": "2024-01-01",
      "end_date": "2024-01-01",
      "balance": {
        "cash": 1050.5,
        "invested": 0
      },
      "last_sync_at": "1970-01-01T00:00:00.000Z"
    }
  ],
  "pagination": {
    "total": 0,
    "limit": 0,
    "offset": 0,
    "has_more": true
  }
}
```

### default

Standard error envelope covering 400, 401, 403, 404, 429, and 500.

- `error` (object)
  The error detail.
  - `code` (string)
    Machine-readable code, e.g. `not_found`, `token_scope_mismatch`, `product_not_enabled`, `insufficient_key_scope`, `insufficient_token_scope`, `user_token_required`, `user_token_expired`, `invalid_user_token`, `invalid_key_configuration`, `connection_not_reconnectable`, `rate_limited`.
  - `message` (string)
    Human-readable error message. May change, so match on `error.code` instead.
  - `param` (string)
    The request field that caused the error, when applicable. Null otherwise.

Example:

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "param": "string"
  }
}
```