Skip to main content
POST
Call briefing.read

Authorizations

Authorization
string
header
required

An API key minted at Settings › API & MCP. Send it as Authorization: Bearer <key>. A key carries its holder's own permissions, resolved on every call — revoking a membership closes the key's reach immediately. Keep it in an environment variable (GOOSY_API_KEY), never in a committed file.

Headers

x-request-id
string

Your own id for this request, echoed back and recorded on the audit trail. 1–128 characters from A–Z a–z 0–9 . _ : -, starting with a letter or digit; anything else is replaced by a generated id.

Maximum string length: 128

Body

application/json
week_of
string

A date inside the week to read (YYYY-MM-DD). Omit for this week.

Pattern: ^\d{4}-\d{2}-\d{2}$
workspace
string

Which workspace to run in — its slug. Omit to use your default. With more than one reachable workspace and no default, the call is refused and the choices are listed.

Minimum string length: 1

Response

The call was admitted and dispatched. ok says whether the tool succeeded — a refusal the tool itself produced is still a 200, exactly as it is a successful JSON-RPC result over MCP.

The tool ran and answered.

ok
boolean
required
week_of
string
required
state
enum<string>
required
Available options:
ready,
generating,
failed,
none
headline
string | null
required
story
string | null
required
highlights
object[]
required
watch_outs
object[]
required
next_moves
object[]
required
other_weeks
object[]
required
timezone_assumed
boolean
required
timezone
string
required
workspace
string
required

The slug of the workspace this call ran in.

working_in
object
required

Which workspace this call ran in, and how that was decided. Present on every workspace-scoped result.