Skip to content
BizPrintBizPrintBizPrint Docs
getbizprint.com

List printers with the BizPrint Print API

This page shows you how to get the printers on your BizPrint account with the BizPrint Print API, and how to look up one printer by its ID. It is for developers who connect their own app or website to BizPrint with an application of the Custom platform.

You need a printer’s ID to create a print job. See Create a print job with the BizPrint Print API. BizPrint does not let you add printers through the API or the BizPrint dashboard. Each station reports its own printers: the BizPrint desktop app reports the printers installed on the computer, and the BizPrint Android app reports the printers you add in the app.

Before you start

Section titled “Before you start”

All addresses on this page start with the Print API base URL:

https://print.bizswoop.app/api/connect-application/v1

Every request also carries the signing parameters publicKey, time and hash in the query string. The examples show them as placeholders.

List all printers

Section titled “List all printers”

Send a GET request to /printers:

GET https://print.bizswoop.app/api/connect-application/v1/printers?perPage=10&page=1&publicKey=YOUR_PUBLIC_KEY&time=YOUR_TIMESTAMP&hash=YOUR_SIGNATURE

The list includes the printers of every station on your BizPrint account.

Query parameter Required What it does
perPage No How many printers to return, from 1 to 100. The default is 10.
page No Which page to return, starting at 1. The default is 1.

The list is split into pages. To get every printer, read the pagination headers in the response and ask for the next page until there are no more. See Page through results with the BizPrint Print API.

What you get back

Section titled “What you get back”

The response is a JSON object with a data list. Each item is one printer:

{
  "data": [
    {
      "id": "YOUR_PRINTER_ID",
      "name": "Front counter receipt printer",
      "status": "online",
      "key": "...",
      "createdAt": "2026-01-15T10:00:00.000Z",
      "updatedAt": "2026-01-15T10:00:00.000Z",
      "station": {
        "id": "YOUR_STATION_ID",
        "name": "Front counter"
      }
    }
  ]
}

In a real response, id and station.id are numbers. The example uses placeholders.

Field What it means
id The printer ID. Send this as printerId when you create a print job.
name The printer’s name, as the station reports it.
status online if the printer was in the latest list of printers its station reported, offline if it was not. It does not show whether the station is connected right now.
key Used by BizPrint. You do not need it.
createdAt, updatedAt When BizPrint first saw the printer, and when its record last changed.
station The station the printer belongs to: its id and name.

Items in the list also include an older Station field with only the station name. Use station instead.

Look up one printer

Section titled “Look up one printer”

Send a GET request to /printers/{id}, with the printer ID in the address:

GET https://print.bizswoop.app/api/connect-application/v1/printers/YOUR_PRINTER_ID?publicKey=YOUR_PUBLIC_KEY&time=YOUR_TIMESTAMP&hash=YOUR_SIGNATURE

The response is a JSON object with one printer in data, with the same fields as an item in the list (without the older Station field):

{
  "data": {
    "id": "YOUR_PRINTER_ID",
    "name": "Front counter receipt printer",
    "status": "online",
    "key": "...",
    "createdAt": "2026-01-15T10:00:00.000Z",
    "updatedAt": "2026-01-15T10:00:00.000Z",
    "station": {
      "id": "YOUR_STATION_ID",
      "name": "Front counter"
    }
  }
}

If the printer does not exist, you get a 404 error with the code ERR_NOT_FOUND. If the printer belongs to another BizPrint account, you get a 403 error with the code ERR_ACCESS_FORBIDDEN. See BizPrint Print API error codes and how to fix them.

Choose the right printer

Section titled “Choose the right printer”
  • Match by name and station. Several stations can have printers with the same name. Use the station name as well as the printer name to pick the right one, then save its id in your app’s settings.
  • Check the status. A printer that is offline was missing from its station’s latest list of printers, for example because it was removed from the computer. An online printer can still be on a station that is switched off, so the status is not a promise that a job prints straight away. When a station is offline, a job you send waits or is archived, depending on the dashboard setting described in Choose what happens to BizPrint print jobs when a station is offline.
  • Know the difference between offline and gone.
    • A printer that is removed from a computer running the BizPrint desktop app shows as offline and keeps its ID. BizPrint still accepts new jobs for it, so check its status before you send.
    • A printer that someone deletes in the BizPrint Android app is removed from BizPrint, so its ID stops working. If the printer is added again, it gets a new ID, and your app needs to use the new one.
    • A printer ID also stops working when the printer no longer belongs to your account.
    • New jobs sent to an ID that stopped working fail with ERR_JOB_CREATING_INVALID_PRINTER_ID. List the printers again and update the ID your app uses.
Section titled “Related pages”

Need help? Contact BizPrint support at https://getbizprint.com/support/.