---
title: "List all wallets"
method: GET
path: "/v2/wallets"
tags: ["wallet"]
---

# List all wallets

`GET /v2/wallets`

This endpoint retrieves a list of wallets based on specified filters and parameters, including team ID, wallet name, wallet ID, external ID, and more. Supports pagination and sorting to manage large sets of data effectively.

## Query parameters

- `pageToken` string
- `pageSize` string, int64
- `teamId` string
- `archived` boolean
- `name` string
- `sortOptions.key` 'SORT_OPTION_KEY_NAME' | 'SORT_OPTION_KEY_AVAILABLE_BALANCE'
- `sortOptions.order` 'SORT_OPTION_ORDER_ASC' | 'SORT_OPTION_ORDER_DESC'
- `id` string
- `externalId` string
- `requestTeamId` string

## Response `200`

A list of wallets and a pagination token.

- V2ListWalletsResponse
  - `wallets` V2ListWallet[] — The list of wallets that match the criteria specified in the request.
    - `id` string — Represents the identifier of the wallet.
    - `namespaceId` string — Specifies the unique identifier of the team that the wallet will be associated with.
    - `teamId` string — The unique identifier of the team to which the wallet is assigned.
    - `name` string — The name of the wallet.
    - `externalId` string — Specifies the optional external ID field to store custom identifiers, such as Placement IO numbers, purchase order numbers, or Salesforce numbers, for tracking purposes. This field is available for partners to associate external identifiers with the wallet. Ensure the external ID is shorter than 255 characters, as no other validation is applied.
    - `currencyCode` string — Indicates the currency code of the wallet, using the 3-letter ISO 4217 standard.
    - `creditLimit` string — Specifies the maximum credit limit assigned to the wallet.
    - `dailyBudget` string — The limit amount that determines the daily spend of the wallet.
    - `archived` boolean — Indicates whether the wallet is archived.
    - `currentBalance` string — Displays the total amount currently in the wallet.
    - `availableBalance` string — Shows the amount available in the wallet for spending.
    - `cappedAvailableBalance` string — Reflects the remaining amount available for spending under daily or monthly caps. If no caps are set, this equals the available balance, and unspent funds roll over to the next day.
  - `nextPageToken` string — The page token for requesting the next page of the pagination. Should be used as "pageToken" in the request.
  - `totalCount` string, int64 — The total number of wallets that meet the specified criteria.

## Other responses

- `400` — There was a problem with input.
- `401` — Login failed or token not valid.
- `403` — Access denied due to insufficient permissions.
- `default` — An unexpected error response.

---

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