MyQ REST API documentation
MyQ REST API documentation
Breadcrumbs

Search for Printer

GET /v3/printers/

Get a list of printers. Results can be filtered by other endpoints.

URL parameters can be used to filter the result.

Name

Type

Description

status

string

Available values : active, local, offline, withIssue

mode

string

Available values : online, offline, local

name

string

Printer name

serialNumber

string

Printer serial number

mac

string

Printer MAC address

group

string

Full group name including parents (top parent is always All printers)

Example:

  • All printers/group 1/group 2

  • All printers/group 3

Example request could be: https://localhost:8090/api/v3/printers?group=All printers/group 1

Other endpoints available to filter the end result:

  • GET /v3/printers/{id}

  • GET /v3/printers/active

  • GET /v3/printers/local

  • GET /v3/printers/offline

  • GET /v3/printers/withIssue

  • GET /v3/printers/last

Headers:
Content-Type: application/json
Authentication: Bearer %access_token%

Authentication:
Grant_type: client_credentials
Scopes: [ printers ]

Response body:
{
  "printers": [
    {
      "id": 0,
      "name": "string",
      "state": "active",
      "mode": "online",
      "ipAddress": "string",
      "serialNumber": "string",
      "mac": "string",
      "terminalId": "string",
      "brand": "string",
      "model": "string",
      "notes": "string",
      "location": "string",
      "enforcedModel": "string",
      "configurationId": 0
    }
  ],
  "count": 0
}


GET /v3/printers/ip:{ip}/loggedUser

Get the user logged in the printer with the specified IP address.

Headers:
Content-Type: application/json
Authentication: Bearer %access_token%

Authentication:
Grant_type: client_credentials, login_info
Scopes: [ users ]