Skip to main content
POST
Call connections.call

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
Idempotency-Key
string

Your key for this write: send the same key when you retry and the first result comes back instead of a second action. Keys are honoured for at least 24 hours. 1–200 visible ASCII characters. Replaces the idempotency_key body field, which still works until 2026-12-31.

Maximum string length: 200

Body

application/json
connection
string

The name this site bound the connection under.

Required string length: 1 - 64
method
string

GET, HEAD, POST, PUT, PATCH or DELETE.

Minimum string length: 1
path
string

The path on the connection's host, beginning with one /.

Minimum string length: 1
query
object

Query string parameters, name to value.

headers
object

Extra request headers; never a credential — the connection signs the request in.

body

The JSON body. A GET or HEAD sends none.

confirmation_id
string<uuid>

Confirms the stored exact call. When supplied, the stored request replaces all other body fields.

idempotency_key
string

Deprecated on REST: send the Idempotency-Key header instead. Still accepted until 2026-12-31; if both are sent they must match.

Required string length: 1 - 256
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
state
enum<string>
required
Available options:
confirmation_required,
completed,
reconciliation_required,
terminal_replay
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.

confirmation_id
string<uuid> | null
expires_in_seconds
integer
request_id
string<uuid> | null
status
enum<string> | null
Available options:
succeeded,
failed,
uncertain,
running
response
unknown
error_code
string | null