GEgetkisi
Cards

Fetch cards

Changed on
get/cards

Request

  • Base URL
    https://api.kisi.io
  • Auth
    • API key in header Authorization
    • or OAuth 2
      Authorization codehttps://api.kisi.io/oauth/authorize
      Token URLhttps://api.kisi.io/oauth/token
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

idsstring

Filter by object IDs

limitinteger

The number of objects to return

offsetinteger

The number of objects to offset

status'activated' | 'deactivated' | 'unassigned'

Filter by status

tokenstring

Filter by the token of the card.

data_block_valuestring

Filter by the data_block_value of the card. Only relevant for Mifare Classic cards.

uidstring

Filter by the uid of the card.

integer
OR
string

Filter by user ID or by current user if value is me.

facility_codeinteger

Filter by the facility code of the record. Only relevant for LF cards.

activatedboolean

Filter by the activation status of the card.

card_numberinteger

Filter by the card number of the record. Only relevant for LF cards.

card_idinteger

Filter by the card id of the record. Only relevant for LF cards.

sort'last_used_at' | '-last_used_at'

Sort the results. Prepend - to sort in reverse order.

last_used_at - sort by when the card was last used

Response

OK

Changes

  • 9c81a7a309b3Revision changes
    • breaking

      added subschema #14: Third Party Optical QR Code - Static subschema #15: Third Party Optical Barcode - Static subschema #16: Third Party Optical QR Code - Rotating subschema #17: Third Party Optical Barcode - Rotating subschema #18: Third Party Optical QR Code - ClubOS to the response property oneOf list for the response status

    • info

      removed subschema #14: QR Code subschema #15: Barcode from the response property oneOf list for the response status

  • f84bf70ab13dRevision changes
    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status