Get printer

GET/v20/printers/{printerId}

Returns a printer by ID. The printer must belong to the authenticated account — requests for printers owned by other accounts return 404.

Authentication

Requires HTTP Basic authentication with your API Credential ID and Token.

Content Type

application/vnd.api+json

Path Parameters

Parameter	Type	Required	Description
printerId	string (UUID)	Yes	The printer ID

Response

200 — Printer details (JSON:API)

{
  "data": {
    "type": "printers",
    "id": "f9d43179-9c10-4502-8f62-892740a65318",
    "attributes": {
      "name": "Front Counter",
      "enabled": true,
      "legacyId": "legacy-printer-001",
      "jobCount": 142,
      "createdAt": "2026-01-15T08:00:00Z",
      "updatedAt": "2026-03-22T12:00:00Z"
    },
    "relationships": {
      "account": {
        "data": { "type": "accounts", "id": "c75c40ff-3263-4171-afe4-1e138f8ea616" }
      }
    }
  }
}

Attributes

Field	Type	Description
name	string	Printer display name
enabled	boolean	Whether the printer is active and accepting jobs
legacyId	string | null	Legacy printer identifier (for migration)
jobCount	integer	Total number of jobs processed by this printer
createdAt	string (date-time)	Printer creation timestamp
updatedAt	string (date-time)	Last update timestamp

Relationships

Relationship	Type	Description
account	accounts	The account that owns this printer

400 — Missing path parameter

{
  "errors": [
    { "status": "400", "title": "Bad Request", "detail": "printerId path parameter is required" }
  ]
}

403 — Account not found or disabled

{
  "errors": [
    { "status": "403", "title": "Forbidden", "detail": "Account not found" }
  ]
}

404 — Printer not found

Returned when the printer does not exist or belongs to a different account.

{
  "errors": [
    { "status": "404", "title": "Not Found", "detail": "Printer not found" }
  ]
}

401 — Not authorized

Returned when the API credential is invalid, disabled, or missing.