Get Card entities.

GET/api/salto/cards/

GETRequest

import { RecranetApiClient } from "@recranet/sdk";

const client = new RecranetApiClient({ apiKey: process.env.RECRANET_API_KEY! });

const result = await client.salto.cards.list({
  organization: 0,
});

Responses

Response 200

Successful response

application/json

Example responseGenerated from schema

[
  {
    "id": 0,
    "type": "type",
    "validFrom": "2024-07-01T00:00:00Z",
    "validTo": "2024-07-08T00:00:00Z",
    "created": "created",
    "reference": "reference",
    "description": "description",
    "data": "data",
    "automatic": false,
    "modified": "modified",
    "encoded": "encoded",
    "invalidated": "invalidated"
  }
]

Response 400

Bad request

application/json

Example 1

{
  "statusCode": 400,
  "description": "Bad request",
  "errors": [
    "Bad request"
  ]
}

Query parameters

organizationnumberrequired
Organization ID
typestringoptional
saltonumberoptional
excludedReservationnumberoptional
guestnumberoptional
offsetnumberoptional
limitnumberoptional
accommodationUnitnumberoptional
reservationnumberoptional

Returns

Array of Card

Schema shown for 200 · application/json

idnumber
typestring
referencestringoptional
The unique identifier of the card in Salto. For normal cards this contains a serial number (ASCII characters). For mobile cards this contains a phone number.
descriptionstringoptional
datastringoptional
The binary data of the card in Salto (ASCII characters). Only available for cards with type mobile-binary-card.
validFromstring
validTostring
automaticbooleanoptional
Default: false
createdstring
modifiedstringoptional
encodedstringoptional
invalidatedstringoptional