List Cardholders

get

{base_url}/api/distributor/v1/cardholders

Returns cardholders accessible to the authenticated Developer Partner. Each row embeds a cardholder_cards array covering every card the caller can access for that cardholder. Supports filtering by distributor_uuid, marketer_uuid, distributor_card_uuid, status, joined_from/joined_to, location_uuid, and a free-text search on name/email. When include_stats=true each row also gets a stats block (total_spend, total_transactions, active_cards_count, last_transaction_at).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

integer

≥ 1

Defaults to 1

1-based page number

per_page

integer

1 to 100

Defaults to 40

Results per page

string

Substring match on given_name/family_name, exact match on email when the value contains "@", or exact match on phone number (E.164 like +16478036825, or local 10-digit like 6478036825) when the value is digits only.

distributor_uuid

uuid

distributor_card_uuid

uuid

marketer_uuid

uuid

status

string

enum

Cardholder status (inactive/active/removed).

Allowed:

joined_from

date-time

Cardholders with users.created_at >= this datetime.

joined_to

date-time

Cardholders with users.created_at <= this datetime.

location_uuid

uuid

Limit to cardholders who transacted at this location.

include_stats

boolean

Defaults to false

When true, each row includes a stats block.

sort

string

Comma-separated sort keys (created_at, updated_at, last_name, first_name). Prefix with "-" for desc.

Responses

400

rejects with GenericError

401

unauthorized request

403

forbidden request

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200treats input with non-digit chars as a name search, not phone