Skip to main content

Gets all printers.

GET 
/api/web/v1/printers

Gets all printers.

Request​

Query Parameters

    fields string

    The model properties to return.

    withStatus boolean

    Indicates if the current status of each printer is retrieved. Defaults to false if not specified.

Responses​

OK

Schema

  • Array [

    • cardsPrinted int32

    Total cards successfully printed by printer.

    cardsRemaining int32

    number of cards remaining before cleaning

    certificate byte
    deviceId string

    Possible values: Value must match regular expression [a-fA-F0-9]{16}

    Printers unique device ID obtained from the printer LCD.

    firmwareCheckedOn date-time

    The date when the firmware version was last checked

    firmwareUpdateRequestId string

    The request id for an active firmware update

    firmwareUpdatedOn date-time

    The date when the firmware version was last updated

    firmwareVersion string

    The firmware version

    hoppers int32

    The number of hoppers

    id string

    Possible values: Value must match regular expression [a-fA-F0-9-]{32,36}

    location string

    Optional physical location of the printer.

    model string

    The printer model

    name string

    The printer name

    newFirmwareVersion string

    A newer firmware version

    printerType string

    The printer type

    ptpReady boolean

    A flag used to determine if the printer has PTP ribbon or not (Ignore this field in the API request or response)

    retransferRollRemaining double

    percentage of retransfer roll remaining in printer

    ribbonId string

    ID of the cloud enabled ribbon installed in the printer (Ignore this field in the API request or response)

    ribbonRemaining double

    percentage of ribbon remaining in printer

    scSimulator boolean

    A flag used to determine if the smart card simulator needs to be invoked

    status string

    Possible values: [BUSY, IDLE, TIMEOUT, INVALID]

  • ]

Loading...