Skip to developer documentation
Browse developer documentation
MCP documentation / Workspace

Read-only tool

list_sites

Find the websites, IDs, currencies and timezones available in the authorized workspace.

Access: OAuth analytics:read or a privately configured workspace key.

Arguments

No arguments are required. Send an empty arguments object.

List the workspace's websites

Use this JSON-RPC call through an initialized MCP client. Replace example values with your actual website, dates or confirmed setup details.

MCP tools/call request
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "list_sites",
    "arguments": {}
  }
}

Decoded result

Illustrative JSON parsed from the result’s text block.

Decoded JSON result
{
  "workspace": "Example workspace",
  "sites": [
    {
      "id": "site_example",
      "domain": "shop.example.com",
      "currency": "USD",
      "name": "Example shop",
      "timezone": "UTC"
    }
  ]
}

Result fields

list_sites result fields
FieldTypeDescription
workspacestringWorkspace name.
sitesarrayWebsites available to this connection.

sites[] fields

sites nested fields
FieldTypeDescription
idstringWebsite ID.
domainstringDomain.
namestringWebsite name.
currencystringWebsite currency.
timezonestringSaved IANA timezone.

The decoded data follows the list websites response contract, without the REST envelope.

Full MCP result wrapper
MCP result object
{
  "content": [
    {
      "type": "text",
      "text": "{\n  \"workspace\": \"Example workspace\",\n  \"sites\": [\n    {\n      \"id\": \"site_example\",\n      \"domain\": \"shop.example.com\",\n      \"currency\": \"USD\",\n      \"name\": \"Example shop\",\n      \"timezone\": \"UTC\"\n    }\n  ]\n}"
    }
  ]
}

Behavior and limits

Call this first when the intended website is unclear. The tool takes an empty arguments object.

Related documentation