---
title: "Get list of cards"
method: GET
path: "/v3/spend/cards"
tags: ["cards"]
---

# Get list of cards

`GET /v3/spend/cards`

Get a list of card objects. By default, you get 20 results on one page of results. Set `max` in your request to get up to 100 results on one page.

## Query parameters

- `nextPage` string, nullable — Next page of results. When a list has multiple pages, the `nextPage` and `prevPage` values in the response enable you to navigate between the pages of results. Set this field as the `nextPage` value for navigation.
- `prevPage` string, nullable — Previous page of results. Set this field as the `prevPage` value for navigation.
- `max` integer, nullable — Maximum number of results
- `sort` string, nullable — Field name and sort order. You can set only one sort field. The format is `sort={field}:{sort_order}`. The sortable fields are: - `name` - `lastFour` - `status`
- `filters` string, nullable — Field name, operator, and value. You can set multiple filters. The format is `filters={field_01}:{op}:{value},{field_02}:{op}:{value}`. Example: `filters=status:eq:ACTIVATED,budgetIds:in:"abc,def"` The filterable fields are: - `status` - `ACTIVATED`, `NOT_ACTIVATED`, `FROZEN`, `DELETED`. Operators: `eq`. - `budgetIds` - List of string IDs or UUIDs. Operators: `eq`, `in`. - `cardIds` - List of string IDs or UUIDs. Operators: `eq`, `in`. - `userIds` - List of string IDs or UUIDs. Operators: `eq`, `in`. - `types` - `PHYSICAL`, `VIRTUAL_MEMBER`, `VIRTUAL_VENDOR`. Operators: `eq`, `in`.

## Headers

- `apiToken` string, nullable — Access token for Spend & Expense API authentication

## Response `200`

Get list of cards response

- PaginatedCardsResponseDto — Response from a list API request with paging references.
  - `nextPage` string — Next page token
  - `prevPage` string — Previous page token
  - `results` CardResponseDto[] — Results
    - `id` string — BILL-generated ID of the card
    - `uuid` string — BILL-generated UUID of the card
    - `name` string — Card name
    - `userId` string — BILL-generated ID of the user linked with the card
    - `userUuid` string — BILL-generated UUID of the user linked with the card
    - `budgetId` string — BILL-generated ID of the budget linked with the card
    - `budgetUuid` string — BILL-generated UUID of the budget linked with the card
    - `lastFour` string — Last four digits of the card number
    - `validThru` string — BILL-generated card expiration date. The value is in the `MM/YY` format. **Note**: Use the `validThru` value as the expiration date in a card payment. Do not use the `expirationDate` value for this operation.
    - `expirationDate` string, date — User-generated card expiration date. This value is in the `yyyy-MM-dd` format. BILL automatically closes the card account on this date. **Note**: Use the `validThru` value as the expiration date in a card payment. Do not use the `expirationDate` value for this operation.
    - `status` 'ACTIVATED' | 'NOT_ACTIVATED' | 'FROZEN' | 'DELETED' — Card status.
    - `deletedReason` 'CANCELLED' | 'LOST' | 'STOLEN' | 'MISPLACED' | 'FRAUD_CONFIRMED' — Delete card reason. This field is available in the response only when `status` is `DELETED`.
    - `type` 'PHYSICAL' | 'VIRTUAL_MEMBER' | 'VIRTUAL_VENDOR' | 'VIRTUAL' — Card type.
    - `shareBudgetFunds` boolean — Set as `true` to share all the budget funds with the card. This option enables the card user to spend from unallocated budget funds when the allocation is empty.
    - `recurring` boolean — Set as `true` to renew the card funds in the next budget period
    - `recurringLimit` number — Card spend limit for the all future budget periods
    - `currentPeriod` object — Current budget period information about the card
      - `limit` number — Card spend limit for the current budget period
      - `spent` number — Amount spent with the card for the current budget period
    - `createdTime` string, date-time — Created date and time
    - `updatedTime` string, date-time — Updated date and time

## Other responses

- `4XX` — List of errors.
- `5XX` — List of errors.

---

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