GEgetpliant
Cards

List Cards

Changed on

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
get/cards

Request

Query parameters

organizationIdstring uuid required

The ID of the organization to filter by.

cardAccountIdstring uuid

The ID of the card account to filter by. A card always carries the card account it is currently assigned to. Once a card has been reassigned (see the CARD_REASSIGNED callback), it is only returned for its new card account, not for the superseded one.

statusstring[]

A list of statuses of cards to filter by.

cardholderIdstring uuid

The ID of the cardholder to filter by.

typestring[]

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

cardConfigstring[]

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.

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'createdAt' | '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'organizationId' | 'status' | 'cardholderId' | 'updatedAt'

The field to sort by.

sortDirection'ASC' | 'DESC'

The direction to sort by.

Response

Ok

hasNextPageboolean

Indicates whether there is a next page available.

Changes

  • a4fbf7d068b4Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status