# Accounts (/data-api/api-reference/accounts)

List and retrieve bank account information from the Fiskil API.



The Accounts endpoint allows you to retrieve bank account information for an end user who has granted consent.

Endpoints [#endpoints]

| Method | Endpoint       | Description                       |
| ------ | -------------- | --------------------------------- |
| `GET`  | `/v1/accounts` | List all accounts for an end user |

The Account Model [#the-account-model]

| Attribute          | Type    | Description                                                   |
| ------------------ | ------- | ------------------------------------------------------------- |
| `id`               | string  | Unique identifier for the account                             |
| `account_number`   | string  | The account number (may be masked)                            |
| `bsb`              | string  | Bank-State-Branch number                                      |
| `name`             | string  | Account name or nickname                                      |
| `product_name`     | string  | Name of the bank product                                      |
| `product_category` | string  | Category of the product (e.g., TRANS\_AND\_SAVINGS\_ACCOUNTS) |
| `institution_id`   | string  | ID of the institution holding the account                     |
| `consent_id`       | string  | ID of the consent granting access to this account             |
| `is_owned`         | boolean | Whether the end user is the owner of the account              |
| `open_status`      | string  | Account status (OPEN, CLOSED)                                 |
| `creation_date`    | string  | When the account was created                                  |

Example Response [#example-response]

```json
{
  "id": "acc_123456789",
  "account_number": "****1234",
  "bsb": "123-456",
  "name": "Everyday Account",
  "product_name": "Complete Freedom Account",
  "product_category": "TRANS_AND_SAVINGS_ACCOUNTS",
  "institution_id": "22",
  "consent_id": "94549a73-a554-4b76-b824-d96898829751",
  "is_owned": true,
  "open_status": "OPEN",
  "creation_date": "2020-01-15"
}
```

List All Accounts [#list-all-accounts]

Retrieve all bank accounts for an end user.

```
GET https://api.fiskil.com/v1/accounts
```

Query Parameters [#query-parameters]

| Parameter          | Type    | Required | Description                             |
| ------------------ | ------- | -------- | --------------------------------------- |
| `end_user_id`      | string  | Yes      | The ID of the end user                  |
| `institution_id`   | string  | No       | Filter by institution ID                |
| `product_category` | string  | No       | Filter by product category              |
| `open_status`      | string  | No       | Filter by open status (OPEN, CLOSED)    |
| `limit`            | integer | No       | Maximum number of results (default: 25) |
| `offset`           | integer | No       | Number of results to skip               |

Example Request [#example-request]

<Tabs items={['cURL', 'Node.js', 'Python']}>
  <Tab value="cURL">
    ```bash
    curl --request GET \
      --url 'https://api.fiskil.com/v1/accounts?end_user_id=482c0e2b-5866-46b1-b795-220b7bba45b5' \
      --header 'Authorization: Bearer {access_token}' \
      --header 'accept: application/json; charset=UTF-8'
    ```
  </Tab>

  <Tab value="Node.js">
    ```javascript
    const response = await fetch(
      'https://api.fiskil.com/v1/accounts?end_user_id=482c0e2b-5866-46b1-b795-220b7bba45b5',
      {
        method: 'GET',
        headers: {
          'Authorization': 'Bearer {access_token}',
          'accept': 'application/json; charset=UTF-8'
        }
      }
    );

    const accounts = await response.json();
    ```
  </Tab>

  <Tab value="Python">
    ```python
    import requests

    response = requests.get(
        'https://api.fiskil.com/v1/accounts',
        params={'end_user_id': '482c0e2b-5866-46b1-b795-220b7bba45b5'},
        headers={
            'Authorization': 'Bearer {access_token}',
            'accept': 'application/json; charset=UTF-8'
        }
    )

    accounts = response.json()
    ```
  </Tab>
</Tabs>

Example Response [#example-response-1]

```json
{
  "data": [
    {
      "id": "acc_123456789",
      "account_number": "****1234",
      "bsb": "123-456",
      "name": "Everyday Account",
      "product_name": "Complete Freedom Account",
      "product_category": "TRANS_AND_SAVINGS_ACCOUNTS",
      "institution_id": "22",
      "consent_id": "94549a73-a554-4b76-b824-d96898829751",
      "is_owned": true,
      "open_status": "OPEN",
      "creation_date": "2020-01-15"
    },
    {
      "id": "acc_987654321",
      "account_number": "****5678",
      "bsb": "123-456",
      "name": "Savings Account",
      "product_name": "Goal Saver",
      "product_category": "TRANS_AND_SAVINGS_ACCOUNTS",
      "institution_id": "22",
      "consent_id": "94549a73-a554-4b76-b824-d96898829751",
      "is_owned": true,
      "open_status": "OPEN",
      "creation_date": "2020-03-20"
    }
  ],
  "links": {
    "next": "https://api.fiskil.com/v1/accounts?end_user_id=482c0e2b-5866-46b1-b795-220b7bba45b5&offset=25"
  }
}
```

Product Categories [#product-categories]

Common product categories you may encounter:

| Category                     | Description                      |
| ---------------------------- | -------------------------------- |
| `TRANS_AND_SAVINGS_ACCOUNTS` | Transaction and savings accounts |
| `CRED_AND_CHRG_CARDS`        | Credit and charge cards          |
| `TERM_DEPOSITS`              | Term deposits                    |
| `PERS_LOANS`                 | Personal loans                   |
| `MARGIN_LOANS`               | Margin loans                     |
| `LEASES`                     | Leases                           |
| `TRADE_FINANCE`              | Trade finance accounts           |
| `REGULATED_TRUST_ACCOUNTS`   | Regulated trust accounts         |
| `RESIDENTIAL_MORTGAGES`      | Residential mortgages            |
| `BUSINESS_LOANS`             | Business loans                   |
| `OVERDRAFTS`                 | Overdraft facilities             |

Related Endpoints [#related-endpoints]

* [Balance](/data-api/api-reference/balance) - Get the balance for accounts
* [Transactions](/data-api/api-reference/getBankingTransactions) - Get transaction history for accounts