Get Desk Batch
GET /desk/batch
This rep’s batch for their local day.
data is NULL when no batch has been started today. That is different
from a batch with nothing left in it, and the difference decides whether a
UI shows “start your day” or “you are done” - so it is preserved rather
than flattened into an empty batch.
The app’s include=overview composite is deliberately not exposed: it
returns a different response shape from the same path, which is a shell
optimisation rather than a contract a rebuilder should depend on.
Authorizations
Parameters
Query Parameters
The rep’s UTC offset in MINUTES (local = UTC + tz_offset). A batch is scoped to the rep’s local day; a wrong offset silently returns the wrong day rather than erroring.
The rep’s UTC offset in MINUTES (local = UTC + tz_offset). A batch is scoped to the rep’s local day; a wrong offset silently returns the wrong day rather than erroring.
Header Parameters
Responses
200
Successful Response
object
Today’s frozen batch.
A batch is FINITE by design: the rep freezes a ranked slice of the queue so
the day has an end. None from the app means no batch has been started
today, which is different from a batch with no items left - the response
keeps that distinction rather than flattening both to an empty batch.
object
422
Validation Error