Skip to main content
POST
Call schedule.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.

Body

application/json
week
string

Any date in the wanted week, as YYYY-MM-DD. Omit for the current week.

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_start
string
required

The Monday of the returned week.

days
string[]
required

The week's seven day columns.

display_time_zone
string | null
required

The zone every day column is bucketed in.

has_cadence
boolean
required

False when this workspace has no active cadence template.

meta_line
string
required
rows
object[]
required
pieces
object[]
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.