Search cardholders

post

https://api.staging.berkeleypayment.com/rest/v1/instant_issuance/cardholders/search

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

allocation_ids

array of int64s | null

Filter by allocation IDs (match any)

allocation_ids

assigned

boolean

Filter by assigned status (true=assigned, false=unassigned, omit=all)

assigned_at_from

date-time

Filter cardholders assigned on or after this time

assigned_at_to

date-time

Filter cardholders assigned on or before this time

campaign_ids

array of int64s | null

Filter by campaign IDs (match any)

campaign_ids

desc

boolean

Sort descending (default true)

external_reference

string

length between 1 and 128

Filter by client correlation identifier (exact match). Can match more than one cardholder unless your company requires unique external references.

external_tag

string

Filter by external tag prefix match

int64

Filter by exact cardholder ID

inventory_statuses

array of strings | null

Filter by inventory statuses (match any)

inventory_statuses

office_ids

array of int64s | null

Filter by office IDs (match any)

office_ids

order_by

string

enum

Field to order by

Allowed:

page

int64

≥ 1

Page number (default 1)

per_page

int64

1 to 100

Items per page (default 10, max 100)

prn

string

Filter by primary processor reference prefix match

Headers

Idempotency-Key

string

length ≤ 255

Optional idempotency key. Replaying within 24h returns the cached response; reusing a key with different parameters returns 400 idempotency_params_error.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

Loading…

Response

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

application/json

application/problem+json

200OK

defaultError