Skip to content

List Desk Blocks

GET
/desk/blocks

Dial passes due per list, from the redial ladder over call activity.

A “block” is batched calling work: one of the rep’s pinned lists, plus how many of its contacts the ladder says are due a call today.

Authorizations

Parameters

Query Parameters

tz_offset

The rep’s UTC offset in MINUTES (local = UTC + tz_offset). The desk day is the rep’s LOCAL day; a wrong offset silently returns the wrong day rather than erroring.

integer
>= -840 <= 840

The rep’s UTC offset in MINUTES (local = UTC + tz_offset). The desk day is the rep’s LOCAL day; a wrong offset silently returns the wrong day rather than erroring.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

An open envelope for a LIST result, so a bare list keeps its shape.

object
items
Array
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
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

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