Desk

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.)

get/desk/kickoff

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/desk/kickoff
  • Auth: HTTP bearer

Query parameters

tz_offsetinteger

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.

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Response

Successful Response

dataDeskPayload 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.

Changes

No recorded changes to this operation across all 2 revisions of this API.