Skip to main content
GET
List Cardholders

Overview

Retrieve a paginated list of cardholders associated with your application. Use filters to narrow down results by status, KYC status, or search terms.

Query Parameters

Response

Cardholder Object (Summary)

Example Usage

Example Response

Filtering Tips

By KYC Status

Search by Name or Email

Combine Filters

Use the search parameter to quickly find cardholders by name or email. The search is case-insensitive and matches partial strings.

Authorizations

Authorization
string
header
required

JWT access token obtained from /auth/token

Query Parameters

page
integer
default:1

Page number (default: 1)

limit
integer
default:20

Items per page (default: 20, max: 100)

Required range: x <= 100
status
enum<string>

Filter by cardholder status

Available options:
ACTIVE,
INACTIVE,
SUSPENDED
kycStatus
enum<string>

Filter by KYC verification status

Available options:
UNSUBMITTED,
SUBMITTED,
ACCEPTED,
REJECTED

Search by name or email (partial match)

Response

Cardholders retrieved successfully

success
boolean
Example:

true

status
integer
Example:

200

message
string
Example:

"Cardholders retrieved successfully"

data
object
meta
object