---
title: "Get a list of all xs2a.api bank users"
method: GET
path: "/api/users"
tags: ["XS2A.api.users"]
---

# Get a list of all xs2a.api bank users

`GET /api/users`

## Query parameters

- `per_page` integer
- `page` integer

## Response `200`

Request successfully processed

- BankUserList
  - `total` integer — Total number of results.
  - `per_page` integer — Number of objects per page
  - `current_page` integer — Current page.
  - `last_page` integer — Last page, usually the total of available pages.
  - `next_page_url` string, nullable — URI to next page.
  - `prev_page_url` string, nullable — URI to previous page.
  - `from` integer — Showing results from index element.
  - `to` integer — Showing results to index element.
  - `data` BankUser[]
    - `id` string — Bank user ID
    - `name` string — Name of the user
    - `email` string, email — E-Mail of the test user
    - `testmode` boolean — True, if this user has been created with a testing API key, false otherwise.
    - `created_at` string — Date of creation
    - `object` string — The value bank_user

## Other responses

- `401` — Authentication failed API key missing or not valid
- `403` — Forbidden Access blocked
- `404` — Product not enabled or Not found The requested object does not exist on the server
- `422` — Validation failed Something is wrong with the user input
- `500` — An internal server problem occurred

---

[API](https://skmtc.dev/xs2a/apis/xs2a-api.md) · [All operations](https://skmtc.dev/xs2a/apis/xs2a-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/xs2a/xs2a-api/revisions/ae5fbc5feee3/schema)