---
title: "Get Accounts"
method: GET
path: "/accounts"
---

# Get Accounts

`GET /accounts`

Fetches existing accounts according to query parameters.

## Query parameters

- `page` integer
- `limit` integer
- `currency` 'ALL' | 'NGN' | 'USD'
- `type` 'account' | 'wallet'

## Response `200`

Accounts fetched successfully.

- object
  - `statusCode` integer — Status code of the response. `200` indicates a successful request.
  - `message` string — Human-readable description of the result.
  - `data` object[] — Array of objects for the requested page.
    - `_id` string — Unique identifier of the object.
    - `business` string — Identifier of the business that owns this object.
    - `customer` string — Associated customer — an id, or a summary object on nested resources.
    - `type` string — Type of the object.
    - `currency` string — ISO 4217 currency code (e.g. `NGN`).
    - `accountName` string — Name on the account.
    - `bankCode` string — Bank / institution code.
    - `accountType` string — Account product type (`Savings` or `Current`).
    - `accountNumber` string — Account number (NUBAN).
    - `currentBalance` integer — Current ledger balance, in the minor currency unit.
    - `availableBalance` integer — Balance available for spending, in the minor currency unit.
    - `provider` string — Underlying provider backing the object.
    - `providerReference` string
    - `referenceCode` string
    - `reloadable` boolean
    - `isDefault` boolean
    - `isDeleted` boolean — Whether the object has been soft-deleted.
    - `createdAt` string, date-time — ISO 8601 timestamp of when the object was created.
    - `updatedAt` string, date-time — ISO 8601 timestamp of when the object was last updated.
    - `charges` unknown[]
      - unknown
    - `__v` integer — Internal document version (Mongo).
  - `pagination` object — Pagination metadata for the result set.
    - `total` integer — Total number of records matching the query across all pages.
    - `pages` integer — Total number of pages available for the current query.
    - `page` integer — Current page index (zero-based; matches the `page` query parameter).
    - `limit` integer — Maximum number of records returned per page (matches the `limit` query parameter).

## Other responses

- `400` — Validation error.
- `401` — Authentication failed — missing or invalid API key.

---

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