Desk

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.

get/desk/batch

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/desk/batch
  • Auth: HTTP bearer

Query parameters

tz_offsetinteger

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.

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Response

Successful Response

Changes

No recorded changes to this operation across all 2 revisions of this API.