Skip to content

Pull Desk Batch

POST
/desk/batch/pull

Append more cards to today’s existing batch.

Capped lower than start (40 vs 80) on purpose: pulling is a top-up, not a second day.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Append newly selected cards to today’s existing batch.

object
item_ids
required

Decision ids to append. 1-40 - a smaller cap than start, by design.

Array<string>
>= 1 items <= 40 items
tz_offset

The rep’s UTC offset in minutes.

integer
>= -840 <= 840

Responses

200

Successful Response

object
data
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.

object
completed
Any of:
integer
completed_at
Any of:
string format: date-time
id
Any of:
string
item_ids
Array<string>
remaining
Any of:
integer
started_at
Any of:
string format: date-time
status
Any of:
string
total
Any of:
integer
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string