Skip to main content
GET
Download a site's code project as a zip

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.

Path Parameters

siteId
string<uuid>
required

The UUID of a site in the resolved workspace.

Query Parameters

workspace
string

Which workspace to act in — its slug or id. The SAME argument every workspace-scoped tool takes, resolved the same way: an account-wide key may select any workspace its holder currently reaches, a workspace-pinned key may only name its own, and a call that names nothing falls through to your default. It is a QUERY parameter rather than a body field on purpose: this endpoint's body is a multipart upload, and reading a field out of it would decode that body before the bearer and the rate limiter had run.

Minimum string length: 1

Response

The zip. Content-Disposition: attachment; filename="<site>-<ref>.zip", X-Goosy-Export-Kind (managed or bundle) and X-Goosy-Export-Ref (the ref the zip is byte-identical to).

The response is of type file.