Skip to content

Get Desk Kickoff

GET
/desk/kickoff

The rep’s 60-second AI daily briefing, cached per local day.

SPENDS CREDITS ON THE FIRST READ OF THE DAY: a cache miss builds the briefing with a charged model call; every later read that day is served from the cache. That is why this GET is tiered billable, not read.

{"enabled": false} when the org’s morning_kickoff switch is off.

The app’s force=true rebuild is NOT published, and that is a spend decision rather than a tidiness one: the briefing is one model call per rep per local day, and a published force turns a dashboard poll into a charged call per request. Read the cached one; it is the same briefing the rep sees. (force=False is passed EXPLICITLY below - the app’s default is a Query instance, which is truthy, so omitting it would force a rebuild on every single call.)

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 one desk object.

Open on purpose - see the module docstring. A rebuilder gets every field the desk returns, including ones added after this contract version.

object
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