---
title: "List banks"
method: GET
path: "/banks/"
tags: ["Payments"]
---

# List banks

`GET /banks/`

## Query parameters

- `page` integer
- `page_size` integer
- `status` 'active' | 'authentication_failed' | 'unknown_error' | 'archived'

## Headers

- `x-simple-workspace` string, required
- `x-piriod-test-mode` boolean

## Response `200`

Paginated bank list.

- object
  - `count` integer, required — Total number of items matching the filter.
  - `next` string, uri, nullable — URL of the next page, or `null` if last page.
  - `previous` string, uri, nullable — URL of the previous page, or `null` if first page.
  - `results` Bank[], required — The items in the current page.
    - `id` string
    - `bank` integer, required — Reference to the underlying bank entity (`/generals/banks/`).
    - `name` string, nullable
    - `number` string, nullable
    - `holder_id` string, nullable
    - `holder_name` string, nullable
    - `account_type` 'checking_account' | 'savings_account' | 'sight_account' | 'rut_account' | 'line_of_credit', nullable
    - `auto_match` boolean
    - `extra_data` object
    - `last_sync` string, date-time, nullable
    - `status` 'active' | 'authentication_failed' | 'unknown_error' | 'archived'
    - `archived` string, date-time, nullable
    - `created` string, date-time
    - `updated` string, date-time

---

[API](https://skmtc.net/piriod/apis/piriod-api.md) · [All operations](https://skmtc.net/piriod/apis/piriod-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/piriod/piriod-api/versions/70cbc827dc7b/schema)