List Cards
Returns a list of cards. You can use the limit, page, sortBy and sortDirection parameters to filter and sort the results.
This endpoint has changed in comparison to the previous version of the API. The following changes were made:
- changed the enumeration for the status field in the response body
Query parameters
The ID of the organization to filter by.
The ID of the card account to filter by.
A list of statuses of cards to filter by.
The ID of the cardholder to filter by.
DEPRECATED: Use cardConfig parameter instead. A list of types of cards to filter by.
Filter by exact card configuration (e.g., PLIANT_PHYSICAL, PLIANT_VIRTUAL_TRAVEL, PLIANT_SINGLE_USE). Can be specified multiple times for filtering by multiple configurations.
The from date to filter by as zero-offset UTC time. The date boundary is inclusive. Meaning we compare with >=.
The to date to filter by as zero-offset UTC time. The date boundary is inclusive. Meaning we compare with <=.
The date field to filter by if fromDate and toDate are present.
The maximum number of items to return per page. The default value if not provided is 100, the maximum allowed value is 1000.
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.
The field to sort by.
The direction to sort by.
Response
Ok