Data API Tools

Pages

Manage static pages in your Webflow site, update page metadata and settings, and modify page content using the Pages tools.

List pages

List all pages within a site. Returns page metadata including IDs, titles, and slugs.

Tool: pages_list

site_id
stringRequired

The site’s unique ID, used to list its pages.

localeId
string

Unique identifier for a specific locale. Applicable when using localization.

limit
number

Maximum number of records to be returned (max limit: 100)

offset
number

Offset used for pagination if the results have more than limit records.

GET
/v2/sites/:site_id/pages
1import { WebflowClient } from "webflow-api";
2
3async function main() {
4    const client = new WebflowClient({
5        accessToken: "YOUR_TOKEN_HERE",
6    });
7    await client.pages.list("580e63e98c9a982ac9b8b741", {
8        localeId: "65427cf400e02b306eaa04a0",
9        limit: 100,
10        offset: 0,
11    });
12}
13main();
Try it

Returns

Response
1{
2  "pages": [
3    {
4      "id": "6596da6045e56dee495bcbba",
5      "siteId": "6258612d1ee792848f805dcf",
6      "title": "Guide to the Galaxy",
7      "slug": "guide-to-the-galaxy",
8      "createdOn": "2024-03-11T10:42:00.000Z",
9      "lastUpdated": "2024-03-11T10:42:42.000Z",
10      "archived": false,
11      "draft": false,
12      "canBranch": false,
13      "isBranch": true,
14      "branchId": "68026fa68ef6dc744c75b833",
15      "seo": {
16        "title": "The Ultimate Hitchhiker's Guide to the Galaxy",
17        "description": "Everything you need to know about the galaxy, from avoiding Vogon poetry to the importance of towels."
18      },
19      "openGraph": {
20        "title": "Explore the Cosmos with The Ultimate Guide",
21        "titleCopied": false,
22        "description": "Dive deep into the mysteries of the universe with your guide to everything galactic.",
23        "descriptionCopied": false
24      },
25      "localeId": "653fd9af6a07fc9cfd7a5e57",
26      "publishedPath": "/en-us/guide-to-the-galaxy"
27    },
28    {
29      "id": "6596da6045e56dee495bcbad",
30      "siteId": "6258612d1ee792848f805dcf",
31      "title": "Towel Day Celebrations",
32      "slug": "towel-day",
33      "createdOn": "2024-05-25T09:00:00.000Z",
34      "lastUpdated": "2024-05-25T09:42:00.000Z",
35      "archived": false,
36      "draft": false,
37      "canBranch": true,
38      "isBranch": false,
39      "seo": {
40        "title": "Celebrate Towel Day - The Hitchhiker's Guide to the Galaxy",
41        "description": "A guide to celebrating Towel Day, in honor of the most massively useful thing an interstellar hitchhiker can have."
42      },
43      "openGraph": {
44        "title": "Towel Day - Don't Panic",
45        "titleCopied": false,
46        "description": "Join the galaxy in celebrating Towel Day, the day dedicated to carrying towels everywhere in memory of Douglas Adams.",
47        "descriptionCopied": false
48      },
49      "localeId": "653fd9af6a07fc9cfd7a5e57",
50      "publishedPath": "/en-us/towel-day"
51    }
52  ],
53  "pagination": {
54    "limit": 20,
55    "offset": 0,
56    "total": 2
57  }
58}

Get page metadata

Get metadata for a specific page including SEO settings, Open Graph data, and page status (draft/published).

Tool: pages_get_metadata

page_id
stringRequired

Unique identifier for the page.

localeId
string

Unique identifier for a specific locale. Applicable when using localization.

GET
/v2/pages/:page_id
1import { WebflowClient } from "webflow-api";
2
3async function main() {
4    const client = new WebflowClient({
5        accessToken: "YOUR_TOKEN_HERE",
6    });
7    await client.pages.getMetadata("63c720f9347c2139b248e552", {
8        localeId: "65427cf400e02b306eaa04a0",
9    });
10}
11main();
Try it

Returns

Response
1{
2  "id": "6596da6045e56dee495bcbba",
3  "siteId": "6258612d1ee792848f805dcf",
4  "title": "Guide to the Galaxy",
5  "slug": "guide-to-the-galaxy",
6  "createdOn": "2024-03-11T10:42:00.000Z",
7  "lastUpdated": "2024-03-11T10:42:42.000Z",
8  "archived": false,
9  "draft": false,
10  "canBranch": false,
11  "isBranch": true,
12  "branchId": "68026fa68ef6dc744c75b833",
13  "seo": {
14    "title": "The Ultimate Hitchhiker's Guide to the Galaxy",
15    "description": "Everything you need to know about the galaxy, from avoiding Vogon poetry to the importance of towels."
16  },
17  "openGraph": {
18    "title": "Explore the Cosmos with The Ultimate Guide",
19    "titleCopied": false,
20    "description": "Dive deep into the mysteries of the universe with your guide to everything galactic.",
21    "descriptionCopied": false
22  },
23  "localeId": "653fd9af6a07fc9cfd7a5e57",
24  "publishedPath": "/en-us/guide-to-the-galaxy"
25}

Update page settings

Update page settings including SEO metadata, Open Graph data, slug, and publishing status.

Tool: pages_update_page_settings

page_id
stringRequired

Unique identifier for the page.

localeId
string

Unique identifier for a specific locale. Applicable when using localization.

body
objectRequired

Page settings object with fields to update

PUT
/v2/pages/:page_id
1import { WebflowClient } from "webflow-api";
2
3async function main() {
4    const client = new WebflowClient({
5        accessToken: "YOUR_TOKEN_HERE",
6    });
7    await client.pages.updatePageSettings("63c720f9347c2139b248e552", {
8        localeId: "65427cf400e02b306eaa04a0",
9        title: "Guide to the Galaxy",
10        slug: "guide-to-the-galaxy",
11        seo: {
12            title: "The Ultimate Hitchhiker's Guide to the Galaxy",
13            description: "Everything you need to know about the galaxy, from avoiding Vogon poetry to the importance of towels.",
14        },
15        openGraph: {
16            title: "Explore the Cosmos with The Ultimate Guide",
17            titleCopied: false,
18            description: "Dive deep into the mysteries of the universe with your guide to everything galactic.",
19            descriptionCopied: false,
20        },
21    });
22}
23main();
Try it

Returns: Updated page metadata

Response
1{
2  "id": "6596da6045e56dee495bcbba",
3  "siteId": "6258612d1ee792848f805dcf",
4  "title": "Guide to the Galaxy",
5  "slug": "guide-to-the-galaxy",
6  "createdOn": "2024-03-11T10:42:00.000Z",
7  "lastUpdated": "2024-03-11T10:42:42.000Z",
8  "archived": false,
9  "draft": false,
10  "canBranch": false,
11  "isBranch": true,
12  "branchId": "68026fa68ef6dc744c75b833",
13  "seo": {
14    "title": "The Ultimate Hitchhiker's Guide to the Galaxy",
15    "description": "Everything you need to know about the galaxy, from avoiding Vogon poetry to the importance of towels."
16  },
17  "openGraph": {
18    "title": "Explore the Cosmos with The Ultimate Guide",
19    "titleCopied": false,
20    "description": "Dive deep into the mysteries of the universe with your guide to everything galactic.",
21    "descriptionCopied": false
22  },
23  "localeId": "653fd9af6a07fc9cfd7a5e57",
24  "publishedPath": "/en-us/guide-to-the-galaxy"
25}

Get page content

Get the content structure and data for a specific page including all elements and their properties.

Tool: pages_get_content

page_id
stringRequired

Unique identifier for the page.

localeId
string

Unique identifier for a specific locale. Applicable when using localization.

limit
number

Maximum number of records to be returned (max limit: 100)

offset
number

Offset used for pagination if the results have more than limit records.

GET
/v2/pages/:page_id/dom
1import { WebflowClient } from "webflow-api";
2
3async function main() {
4    const client = new WebflowClient({
5        accessToken: "YOUR_TOKEN_HERE",
6    });
7    await client.pages.getContent("63c720f9347c2139b248e552", {
8        localeId: "65427cf400e02b306eaa04a0",
9        limit: 100,
10        offset: 0,
11    });
12}
13main();
Try it

Returns

Response
1{
2  "pageId": "658205daa3e8206a523b5ad4",
3  "nodes": [
4    {
5      "id": "a245c12d-995b-55ee-5ec7-aa36a6cad623",
6      "type": "text",
7      "text": {
8        "html": "<h1>The Hitchhiker's Guide to the Galaxy</h1>",
9        "text": "The Hitchhiker's Guide to the Galaxy"
10      },
11      "attributes": {}
12    },
13    {
14      "id": "a245c12d-995b-55ee-5ec7-aa36a6cad627",
15      "type": "text",
16      "text": {
17        "html": "<div><h3>Don't Panic!</h3><p>Always know where your towel is.</p></div>"
18      },
19      "attributes": {
20        "number": "forty two"
21      }
22    },
23    {
24      "id": "a245c12d-995b-55ee-5ec7-aa36a6cad629",
25      "type": "image",
26      "image": {
27        "alt": "Marvin, the Paranoid Android",
28        "assetId": "659595234426a9fcbad57043"
29      },
30      "attributes": {}
31    },
32    {
33      "id": "a245c12d-995b-55ee-5ec7-aa36a6cad635",
34      "type": "select",
35      "choices": [
36        {
37          "value": "choice-1",
38          "text": "First choice"
39        },
40        {
41          "value": "choice-2",
42          "text": "Second choice"
43        }
44      ],
45      "attributes": {}
46    },
47    {
48      "id": "a245c12d-995b-55ee-5ec7-aa36a6cad642",
49      "type": "text-input",
50      "placeholder": "Enter something here...",
51      "attributes": {}
52    },
53    {
54      "id": "a245c12d-995b-55ee-5ec7-aa36a6cad671",
55      "type": "submit-button",
56      "value": "Submit",
57      "waitingText": "Submitting...",
58      "attributes": {}
59    },
60    {
61      "id": "a245c12d-995b-55ee-5ec7-aa36a6cad631",
62      "type": "component-instance",
63      "componentId": "6258612d1ee792848f805dcf",
64      "propertyOverrides": [
65        {
66          "propertyId": "a245c12d-995b-55ee-5ec7-aa36a6cad633",
67          "type": "Plain Text",
68          "label": "Catchphrase",
69          "text": {
70            "text": "Don't Panic!"
71          }
72        },
73        {
74          "propertyId": "a245c12d-995b-55ee-5ec7-aa36a6cad635",
75          "type": "Rich Text",
76          "label": "Tagline",
77          "text": {
78            "html": "<div><p>Always know where your towel is.</p></div>"
79          }
80        }
81      ]
82    }
83  ],
84  "pagination": {
85    "limit": 4,
86    "offset": 0,
87    "total": 4
88  },
89  "lastUpdated": "2016-10-24T19:42:38.929Z"
90}

Update static content

Update content on a static page in secondary locales by modifying text nodes and property overrides.

Tool: pages_update_static_content

This tool is only for updating content in secondary locales. The localeId parameter is required, and requests to update primary locale content will fail.

page_id
stringRequired

Unique identifier for the page.

localeId
stringRequired

Unique identifier for the target locale.

nodes
arrayRequired

Array of node updates with text content and property overrides

POST
/v2/pages/:page_id/dom
1import { WebflowClient } from "webflow-api";
2
3async function main() {
4    const client = new WebflowClient({
5        accessToken: "YOUR_TOKEN_HERE",
6    });
7    await client.pages.updateStaticContent("63c720f9347c2139b248e552", {
8        localeId: "localeId",
9        nodes: [
10            {
11                nodeId: "a245c12d-995b-55ee-5ec7-aa36a6cad623",
12                text: "<h1>The Hitchhiker's Guide to the Galaxy</h1>",
13            },
14            {
15                nodeId: "a245c12d-995b-55ee-5ec7-aa36a6cad627",
16                text: "<div><h3>Don't Panic!</h3><p>Always know where your towel is.</p></div>",
17            },
18            {
19                nodeId: "a245c12d-995b-55ee-5ec7-aa36a6cad635",
20                text: "<h1>Hello world</h1>",
21            },
22            {
23                nodeId: "a245c12d-995b-55ee-5ec7-aa36a6cad642",
24                text: "<h1>Hello world</h1>",
25            },
26            {
27                nodeId: "a245c12d-995b-55ee-5ec7-aa36a6cad671",
28                text: "<h1>Hello world</h1>",
29            },
30            {
31                nodeId: "a245c12d-995b-55ee-5ec7-aa36a6cad629",
32                text: "<h1>Hello world</h1>",
33            },
34        ],
35    });
36}
37main();
Try it

Returns: Updated page content confirmation

Response
1{
2  "errors": []
3}