API Reference
Changelog UpdatesAPI StatusSupport

List Cards

get
https://partner-api.getpliant.com/api/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 Params
uuid
required

The ID of the organization to filter by.

uuid

The ID of the card account to filter by.

status
array of strings

A list of statuses of cards to filter by.

status
uuid

The ID of the cardholder to filter by.

type
array of strings
deprecated

DEPRECATED: Use cardConfig parameter instead. A list of types of cards to filter by.

type
cardConfig
array of strings

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.

cardConfig
date-time

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

date-time

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

string | null
enum
Defaults to createdAt

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

Allowed:
integer

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

integer

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.

string
enum

The field to sort by.

Allowed:
string
enum

The direction to sort by.

Allowed:
Responses

Updated 13 days ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 13 days ago