Skip to main content
POST
Call page.list

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
include_archived
boolean

True to include archived pages. Leave unset for the board's normal view.

list
enum<string>

Which list to read. 'sites' (the default) is the workspace's pages. 'templates' is the template catalogue page.create starts from — ask for it only when the member wants to pick or hear about a template; it returns no sites.

Available options:
sites,
templates
limit
integer

How many rows to return — at most 50; omit for 10 sites or 7 templates. The reply is one PAGE: a next_cursor in it says rows remain.

Required range: x <= 50
cursor
string

Where to continue: pass the next_cursor from the previous reply, with the same list, include_archived and name. Omit it for the first page. If the list changed since that page, the cursor is refused: start again without it.

Minimum string length: 1
name
string

The site's name or address as the member said it ("Spring promo", "spring-promo.example.com"). Returns just that site with its site_id — an exact name or address first, else the one site whose name starts with it. When several fit, the result lists them as candidates: ask the member which one, never pick. Use this whenever a verb needs a site_id for a site they NAMED. Not with list templates — that call is refused.

Required string length: 1 - 253
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
sites
object[]
required
total_count
integer
required
Required range: x >= 0
live_count
integer
required
Required range: x >= 0
leads_this_month
integer
required
Required range: x >= 0
template_ids
string[]
required
blueprints
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.

this_project
string
list
enum<string>
Available options:
sites,
templates
next_cursor
string
templates_total
integer
Required range: x >= 0
name_match
object