---
title: "List Wallets"
method: GET
path: "/api/v1/wallets/"
tags: ["Wallets"]
---

# List Wallets

`GET /api/v1/wallets/`

## Request

- Base URL: `https://merchant-api.accruesavings.com`
- URL: `https://merchant-api.accruesavings.com/api/v1/wallets/`
- Auth: none declared. Required headers: `Client-ID`, `Authorization`
- TypeScript: <https://skmtc.dev/byaccrue/apis/accrue-merchant-api/docs/api/v1/wallets/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `filter[phoneNumber]` string: Filter the list of objects by the value of the phoneNumber field.
- `filter[email]` string: Filter the list of objects by the value of the email field.
- `filter[referenceId]` string: Filter the list of objects by the value of the referenceId field.
- `page[limit]` number: Maximum number of objects that will be returned. Can not be greater than 50.
- `page[offset]` number: Offset from the beginning of the list of objects. Can not be negative.

## Headers

- `Client-ID` string, uuid, required: The unique identifier of the client making the request. This header is required to retrieve the client-specific configuration and ensure that the response is tailored to the client's settings and permissions.
- `Authorization` string, uuid, required: Secure secret to access privileged endpoints.

## Response `200`

OK

- ListWalletsResponse
  - `data` object[], required
    - `id` string, uuid, required: Unique identifier for the object.
    - `type` 'Wallet', required
    - `attributes` object, required
      - `status` 'Active' | 'ClosingWithClosedLoop' | 'ManualReview' | 'Closed': The current status of the wallet.
      - `closedAt` string, date-time, nullable: The date and time when the wallet was closed.
      - `updatedAt` string, date-time, required
      - `createdAt` string, date-time, required
    - `relationships` object, required
      - `user` object
        - `data` object, required
          - `id` string, uuid, required
          - `type` 'User', required
  - `meta` object, required
    - `total` number, required
    - `limit` number, required
    - `offset` number, required

## Other responses

- `400`: Bad Request
- `500`: Internal Server Error

---

[API](https://skmtc.dev/byaccrue/apis/accrue-merchant-api.md) - [All operations](https://skmtc.dev/byaccrue/apis/accrue-merchant-api/llms.txt) - [OpenAPI document](https://skmtc.dev/byaccrue/apis/accrue-merchant-api/revisions/3e2d97ef2e6e?raw)