Skip to main content
GET
List organization cards
Filter by name (a part of the card’s name or masked number), lastDigits, status and type — status and type take several values, comma-separated (?status=ACTIVE,BLOCKED) — and page with limit + next. Only the cards of the environment in x-environment are listed, so send x-environment: LIVE for production cards. Any member of the organization can list its cards.

Headers

x-environment
enum<string>

Environment whose cards you list: LIVE (production) or TEST (sandbox). When you omit it, you get the TEST cards; any other value is rejected.

Available options:
LIVE,
TEST

Path Parameters

realmId
string<uuid>
required

ID of your realm.

Format: UUID

organizationId
string<uuid>
required

ID of the organization.

Format: UUID

Query Parameters

name
string

Only cards whose name or masked card number contains this text (case-insensitive).

Maximum string length: 256
lastDigits
string

Only cards whose card number ends with these digits.

Maximum string length: 256
status
string[]

Only cards in these statuses (case-insensitive): ACTIVE, BLOCKED or CANCELLED. Other values match no card.


Example (comma-separated list): ?status=ACTIVE,BLOCKED

Maximum string length: 64
type
string[]

Only cards of these types (case-insensitive): VIRTUAL or EMBOSSED (physical). Other values match no card.


Example (comma-separated list): ?type=VIRTUAL,EMBOSSED

Maximum string length: 64
next
string

Cursor returned as next by the previous page. Omit it for the first page.

limit
integer

Page size. Defaults to 15.

Required range: x > 0

Response

Successful response

A page of cards, newest first.

items
object[]
required

The cards of this page.

next
string | null
required

Cursor of the next page: pass it as next to read it. null on the last page.

Example:

"NjZmMmE0YjhiNGQzZTgwMDEyYzlhMGUx"