---
title: "Get Desk Batch"
method: GET
path: "/desk/batch"
tags: ["Desk"]
---

# Get Desk Batch

`GET /desk/batch`

## Request

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

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.

## Query parameters

- `tz_offset` integer: 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

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Response `200`

Successful Response

- ApiResponseUnionDeskBatchNoneType
  - `data` DeskBatch, required: 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.
    - `id` string, nullable
    - `status` string, nullable
    - `item_ids` string[]
    - `total` integer, nullable
    - `completed` integer, nullable
    - `remaining` integer, nullable
    - `started_at` string, date-time, nullable
    - `completed_at` string, date-time, nullable
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)