Skip to main content
GET
Scope: batches:read. A batch number your workspace doesn’t have is a 404.
string
required
The batch number, such as B-1045.
The response has every field of a list item, plus:
string
required
How the codes are printed: gs1_datamatrix, gs1_qr, private_code, or serial only: code128, datamatrix, qr.
string
When the serials were signed. signedBy (id, name, email) is who signed them.
string
string
When the batch was printed.
integer
Once printed: labels printed well. voidedCount is labels voided on the line.
integer
required
Scans of this batch with a counterfeit verdict.
object[]
required
The batch’s files once signed: kind (printer_job, serial_csv, proof_pdf), label, format (ZPL, CSV, PDF) and sizeBytes (an estimate). Empty on drafts.
integer
required
Phones with the Satyakod app that scanned this batch and asked for alerts.
object[]
Recall and copied-code notices sent to those phones, newest first: id, kind (recall or counterfeit), message, createdAt, notified (phones it went to) and, for a revoked range, serials (first, last).
The response also carries what the dashboard’s batch form and print controls use: regionIds, regionLabel, serialFormat, labelTemplateId, printLineId, printLineDevice, signingKeyLocation, canSendToPrinter, printRequestedAt and printError.