GET
/
ext
/
v1
/
cards
List cards
curl --request GET \
  --url https://api.light.inc/rest/ext/v1/cards
{
  "total": 123,
  "records": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "companyEntityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "companyEntityName": "<string>",
      "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "ownerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "ownerName": "<string>",
      "cardBalanceAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "cardBalanceAccountLabel": "<string>",
      "currency": "USD",
      "form": "VIRTUAL",
      "status": "ACTIVE",
      "metadata": {
        "type": "VENDOR"
      },
      "threeDs": {
        "phoneNumber": {
          "countryCode": "UNDEFINED",
          "localNumber": "<string>"
        },
        "password": "<string>",
        "email": "<string>"
      },
      "vendorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "vendorName": "<string>",
      "vendorAvatarUrl": "<string>",
      "description": "<string>",
      "bin": "<string>",
      "lastFour": "<string>",
      "cardholderName": "<string>",
      "limitIntervalSpend": 123,
      "limits": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "cardId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "amount": 123,
          "currency": "USD",
          "interval": "PER_TRANSACTION",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "type": "VENDOR"
    }
  ]
}

Query Parameters

sort
string
Example:

"amount:desc,createdAt:asc"

filter
string
Example:

"state:in:IN_DRAFT|SCHEDULED|PAID,amount:gte:500"

limit
integer
offset
integer

Response

default - application/json;charset=UTF-8

default response

The response is of type object.