Data API: Sites, Pages and Components

// list-sites.ts -- run with: node --env-file=.env list-sites.ts (Node.js 22.18 or later strips the types)
import { WebflowClient } from "webflow-api";

const webflow = new WebflowClient({ accessToken: process.env.WEBFLOW_API_TOKEN! });

const { sites = [] } = await webflow.sites.list();
for (const site of sites) {
  console.log(site.id, site.shortName, site.timeZone, site.lastPublished);
}

const siteId = process.env.WEBFLOW_SITE_ID ?? "REPLACE_WITH_SITE_ID";
const site = await webflow.sites.get(siteId);
console.log(site.locales?.primary?.tag, site.locales?.secondary?.map((l) => l.tag));

curl -s https://api.webflow.com/v2/sites \
  -H "Authorization: Bearer $WEBFLOW_API_TOKEN" \
  -H "accept: application/json"

// publish-staging-then-production.ts
import { WebflowClient } from "webflow-api";

const webflow = new WebflowClient({ accessToken: process.env.WEBFLOW_API_TOKEN! });
const siteId = process.env.WEBFLOW_SITE_ID ?? "REPLACE_WITH_SITE_ID";

async function sleep(ms: number) {
  return new Promise((resolve) => setTimeout(resolve, ms));
}

// 1. Staging first: the webflow.io subdomain only.
await webflow.sites.publish(siteId, { publishToWebflowSubdomain: true });
console.log("Queued staging publish");

// 2. Wait out the one-per-minute limit, then publish the custom domain.
await sleep(61_000);
const { customDomains = [] } = await webflow.sites.getCustomDomain(siteId);
const production = customDomains.find((d) => d.url === "www.fernbrook-gardens.example");
if (!production?.id) throw new Error("Custom domain not found on this site");
await webflow.sites.publish(siteId, { customDomains: [production.id] });
console.log("Queued production publish");

# publish.py -- pip install httpx==0.28.1
import os
import httpx

BASE = "https://api.webflow.com/v2"
HEADERS = {"Authorization": f"Bearer {os.environ['WEBFLOW_API_TOKEN']}"}
SITE_ID = os.environ.get("WEBFLOW_SITE_ID", "REPLACE_WITH_SITE_ID")

# Single-page publish: the pageId property is available in the REST API.
response = httpx.post(
    f"{BASE}/sites/{SITE_ID}/publish",
    headers=HEADERS,
    json={"publishToWebflowSubdomain": True, "pageId": "REPLACE_WITH_PAGE_ID"},
    timeout=30,
)
response.raise_for_status()
print(response.status_code, response.json().get("publishScope"))

curl -s -G "https://api.webflow.com/v2/sites/$WEBFLOW_SITE_ID/pages" \
  -H "Authorization: Bearer $WEBFLOW_API_TOKEN" \
  --data-urlencode "filter[title][contains]=plants" \
  -d limit=100 -d offset=0

// seo-audit.ts -- report pages with a missing or long SEO description, then fix the Spanish title
import { WebflowClient } from "webflow-api";

const webflow = new WebflowClient({ accessToken: process.env.WEBFLOW_API_TOKEN! });
const siteId = process.env.WEBFLOW_SITE_ID ?? "REPLACE_WITH_SITE_ID";

let offset = 0;
const limit = 100;
for (;;) {
  const { pages = [], pagination } = await webflow.pages.list(siteId, { limit, offset });
  for (const page of pages) {
    const description = page.seo?.description ?? "";
    if (page.collectionId || page.draft || page.archived) continue;
    if (description.length === 0 || description.length > 160) {
      console.log(`${page.publishedPath ?? page.slug}: description length ${description.length}`);
    }
  }
  offset += limit;
  if (!pagination || offset >= (pagination.total ?? 0)) break;
}

// Update the Spanish version of one page. The locale ID comes from site.locales.secondary.
const spanishLocaleId = process.env.WEBFLOW_LOCALE_ES ?? "REPLACE_WITH_SPANISH_LOCALE_ID";
await webflow.pages.updatePageSettings("REPLACE_WITH_PAGE_ID", {
  localeId: spanishLocaleId,
  seo: {
    title: "Catalogo de plantas | Fernbrook Gardens",
    description: "Mas de 400 plantas del jardin botanico, con luz, riego y epoca de floracion.",
  },
});

{
  "pageId": "REPLACE_WITH_PAGE_ID",
  "nodes": [
    {
      "id": "a245c12d-995b-55ee-5ec7-aa36a6cad623",
      "type": "text",
      "text": { "html": "<h1>Welcome to Fernbrook Gardens</h1>", "text": "Welcome to Fernbrook Gardens" },
      "attributes": {}
    },
    {
      "id": "a245c12d-995b-55ee-5ec7-aa36a6cad627",
      "type": "text",
      "text": {
        "html": "<div><h3>Opening hours</h3><p>Open <span data-w-id=\"b3107c2e\">every day</span> from 9:00.</p></div>",
        "text": null
      },
      "attributes": {}
    },
    {
      "id": "a245c12d-995b-55ee-5ec7-aa36a6cad629",
      "type": "image",
      "image": { "alt": "Glasshouse in spring", "assetId": "REPLACE_WITH_ASSET_ID" },
      "attributes": {}
    }
  ],
  "pagination": { "limit": 100, "offset": 0, "total": 3 },
  "lastUpdated": "2026-10-20T09:15:00.000Z"
}

// translate-page.ts -- read the primary locale, translate, write the German version
import { WebflowClient } from "webflow-api";

const webflow = new WebflowClient({ accessToken: process.env.WEBFLOW_API_TOKEN! });
const pageId = "REPLACE_WITH_PAGE_ID";
const primaryLocaleId = process.env.WEBFLOW_LOCALE_EN ?? "REPLACE_WITH_PRIMARY_LOCALE_ID";
const germanLocaleId = process.env.WEBFLOW_LOCALE_DE ?? "REPLACE_WITH_GERMAN_LOCALE_ID";

// Placeholder translator: a real pipeline calls a translation service and must preserve the HTML tags.
async function translate(html: string, target: "de" | "es"): Promise<string> {
  return html; // replace with a call to your translation provider
}

const dom = await webflow.pages.getContent(pageId, {
  localeId: primaryLocaleId,
  limit: 100,
  offset: 0,
});

const nodes = [];
for (const node of dom.nodes ?? []) {
  if (node.type === "text" && node.text?.html) {
    nodes.push({ nodeId: node.id, text: await translate(node.text.html, "de") });
  }
}

const result = await webflow.pages.updateStaticContent(pageId, {
  localeId: germanLocaleId,
  nodes,
});
if (result.errors?.length) {
  console.error("Some nodes were rejected:", result.errors);
}

# translate_page.py -- same flow with httpx
import os
import httpx

BASE = "https://api.webflow.com/v2"
HEADERS = {"Authorization": f"Bearer {os.environ['WEBFLOW_API_TOKEN']}"}
PAGE_ID = "REPLACE_WITH_PAGE_ID"
PRIMARY = os.environ.get("WEBFLOW_LOCALE_EN", "REPLACE_WITH_PRIMARY_LOCALE_ID")
GERMAN = os.environ.get("WEBFLOW_LOCALE_DE", "REPLACE_WITH_GERMAN_LOCALE_ID")


def translate(html: str, target: str) -> str:
    return html  # replace with a call to your translation provider


with httpx.Client(headers=HEADERS, timeout=30) as client:
    dom = client.get(
        f"{BASE}/pages/{PAGE_ID}/dom",
        params={"localeId": PRIMARY, "translatable": GERMAN, "limit": 100},
    )
    dom.raise_for_status()
    nodes = [
        {"nodeId": n["id"], "text": translate(n["text"]["html"], "de")}
        for n in dom.json()["nodes"]
        if n["type"] == "text" and n["text"].get("html")
    ]
    result = client.post(
        f"{BASE}/pages/{PAGE_ID}/dom",
        params={"localeId": GERMAN},
        json={"nodes": nodes},
    )
    result.raise_for_status()
    print(result.json()["errors"])

// redirects.ts -- Enterprise workspace required
import { WebflowClient } from "webflow-api";

const webflow = new WebflowClient({ accessToken: process.env.WEBFLOW_API_TOKEN! });
const siteId = process.env.WEBFLOW_SITE_ID ?? "REPLACE_WITH_SITE_ID";

const existing = await webflow.sites.redirects.list(siteId);
const known = new Set((existing.redirects ?? []).map((r) => r.fromUrl));

const wanted = [
  { fromUrl: "/flora/roses", toUrl: "/plants/roses" },
  { fromUrl: "/flora/ferns", toUrl: "/plants/ferns" },
];
for (const rule of wanted) {
  if (!known.has(rule.fromUrl)) {
    await webflow.sites.redirects.create(siteId, rule);
  }
}

curl -s -X PUT "https://api.webflow.com/v2/sites/$WEBFLOW_SITE_ID/robots_txt" \
  -H "Authorization: Bearer $WEBFLOW_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "rules": [
      { "userAgent": "*", "allows": ["/"], "disallows": ["/staff-only/"] }
    ],
    "sitemap": "https://www.fernbrook-gardens.example/sitemap.xml"
  }'

curl -s -X PUT "https://api.webflow.com/v2/sites/$WEBFLOW_SITE_ID/well_known" \
  -H "Authorization: Bearer $WEBFLOW_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "fileName": "security.txt",
    "fileData": "Contact: mailto:security@fernbrook-gardens.example\nExpires: 2027-12-31T23:59:59Z",
    "contentType": "text/plain"
  }'