---
title: "Start Desk Batch"
method: POST
path: "/desk/batch/start"
tags: ["Desk"]
---

# Start Desk Batch

`POST /desk/batch/start`

## Request

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

Freeze a ranked slice of the queue into today's batch.

This is what makes the day finite. Cards added to the queue afterwards do
NOT join the batch on their own - use `/batch/pull` to take more.

## Headers

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

## Request body

- DeskBatchStartRequest: Freeze today's ranked queue into a finite batch. `item_ids` is typed `list[UUID]`, not `list[str]`, so a malformed id is a request-validation 422 that NAMES the offending element. Typed as strings, the app's own `list[UUID]` model raises a pydantic `ValidationError` from inside the handler body instead - the same class of bare-500 the path guard exists to prevent, one layer in.
  - `item_ids` string[], required: Decision ids to freeze into the batch. 1-80 - the cap is the app's.
  - `tz_offset` integer: The rep's UTC offset in MINUTES (local = UTC + tz_offset). A batch is scoped to the rep's local day, so a wrong offset returns yesterday's batch or starts a second one.

## Response `201`

Successful Response

- ApiResponseDeskBatch
  - `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)