v1

latestOpenAPI 3.0.1MIT2026-07-261190449.2 KB

Cardholders

List Cardholders

Returns a list of cardholders. You can use the limit, page, sortBy and sortDirection parameters to filter and sort the results.

get/cardholders

Query parameters

organizationIdstring uuid required

The unique identifier of the organization.

status'INVITED' | 'ACTIVE' | 'DEACTIVATED'

The status to filter by.

emailstring

Filter by email address, case insensitive

fromDatestring date-time

Example:2024-07-19T15:00:00.000000Z

The from date to filter by as zero-offset UTC time. The date boundary is inclusive. Meaning we compare with >=.

toDatestring date-time

Example:2024-07-19T15:00:00.000000Z

The to date to filter by as zero-offset UTC time. The date boundary is inclusive. Meaning we compare with <=.

byDateField'registeredAt' | 'updatedAt' nullable

The date field to filter by if fromDate and toDate are present.

limitinteger

The maximum number of items to return per page. The default value if not provided is 100, the maximum allowed value is 1000.

pageinteger

The page number to return, starting with 0, this counts up to the total number of pages. The total number of pages is determined by the total number of records divided by the limit.

sortBy'firstName' | 'lastName'

The field to sort by.

sortDirection'ASC' | 'DESC'

The direction to sort by.

Response

hasNextPageboolean