GET
/
card

Authorizations

X-API-Key
string
headerrequired

Authentication from public API requests

Query Parameters

filter:legalEntityId
string

Pass in a legal entity ID to filter for cards in accounts under a specific legal entity.

filter:accountId
string

Pass in an account ID to filter for cards under a specific account.

filter:virtualAccountId
string

Pass in a virtual account ID to filter for cards under a specific virtual account.

cursor
string

A cursor string to fetch the next page of results

filter:status
enum<string>

Returns all cards matching the status passed in.

Available options:
active,
paused,
closed,
inactive
filter:cardGroupId
string

Pass in a card group ID, This will return all cards that belong to the card group ID passed in.

sort
enum<string>

Sorts card by creation date or name.

Available options:
createdAt,
name
sortDirection
enum<string>

The direction to apply the sort filter by. Default ASC.

Available options:
ASC,
DESC

Response

200 - application/json
items
object[]
required
metadata
object

Response sent when requesting a list of data