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
1from webflow import Webflow
2
3client = Webflow(
4 access_token="YOUR_ACCESS_TOKEN",
5)
6client.pages.list(
7 site_id="580e63e98c9a982ac9b8b741",
8 locale_id="65427cf400e02b306eaa04a0",
9 limit=1.1,
10 offset=1.1,
11)

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

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
1from webflow import Webflow
2
3client = Webflow(
4 access_token="YOUR_ACCESS_TOKEN",
5)
6client.pages.get_metadata(
7 page_id="63c720f9347c2139b248e552",
8 locale_id="65427cf400e02b306eaa04a0",
9)

Returns

Response
1{
2 "id": "6596da6045e56dee495bcbba",
3 "siteId": "6258612d1ee792848f805dcf",
4 "title": "Guide to the Galaxy",
5 "slug": "guide-to-the-galaxy",
6 "parentId": {},
7 "collectionId": {},
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}

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
1from webflow import Webflow
2from webflow.resources.pages import (
3 PageMetadataWriteOpenGraph,
4 PageMetadataWriteSeo,
5)
6
7client = Webflow(
8 access_token="YOUR_ACCESS_TOKEN",
9)
10client.pages.update_page_settings(
11 page_id="63c720f9347c2139b248e552",
12 locale_id="65427cf400e02b306eaa04a0",
13 title="Guide to the Galaxy",
14 slug="guide-to-the-galaxy",
15 seo=PageMetadataWriteSeo(
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 open_graph=PageMetadataWriteOpenGraph(
20 title="Explore the Cosmos with The Ultimate Guide",
21 title_copied=False,
22 description="Dive deep into the mysteries of the universe with your guide to everything galactic.",
23 description_copied=False,
24 ),
25)

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 "parentId": {},
7 "collectionId": {},
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}

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
1from webflow import Webflow
2
3client = Webflow(
4 access_token="YOUR_ACCESS_TOKEN",
5)
6client.pages.get_content(
7 page_id="63c720f9347c2139b248e552",
8 locale_id="65427cf400e02b306eaa04a0",
9 limit=1.1,
10 offset=1.1,
11)

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

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
1from webflow import (
2 ComponentInstanceNodePropertyOverridesWrite,
3 ComponentInstanceNodePropertyOverridesWritePropertyOverridesItem,
4 Select,
5 SelectNodeWriteChoicesItem,
6 SubmitButtonNodeWrite,
7 TextInputNodeWrite,
8 TextNodeWrite,
9 Webflow,
10)
11
12client = Webflow(
13 access_token="YOUR_ACCESS_TOKEN",
14)
15client.pages.update_static_content(
16 page_id="63c720f9347c2139b248e552",
17 locale_id="localeId",
18 nodes=[
19 TextNodeWrite(
20 node_id="a245c12d-995b-55ee-5ec7-aa36a6cad623",
21 text="<h1>The Hitchhiker's Guide to the Galaxy</h1>",
22 ),
23 TextNodeWrite(
24 node_id="a245c12d-995b-55ee-5ec7-aa36a6cad627",
25 text="<div><h3>Don't Panic!</h3><p>Always know where your towel is.</p></div>",
26 ),
27 Select(
28 node_id="a245c12d-995b-55ee-5ec7-aa36a6cad635",
29 choices=[
30 SelectNodeWriteChoicesItem(
31 value="choice-1",
32 text="First choice",
33 ),
34 SelectNodeWriteChoicesItem(
35 value="choice-2",
36 text="Second choice",
37 ),
38 ],
39 ),
40 TextInputNodeWrite(
41 node_id="a245c12d-995b-55ee-5ec7-aa36a6cad642",
42 placeholder="Enter something here...",
43 ),
44 SubmitButtonNodeWrite(
45 node_id="a245c12d-995b-55ee-5ec7-aa36a6cad671",
46 value="Submit",
47 waiting_text="Submitting...",
48 ),
49 ComponentInstanceNodePropertyOverridesWrite(
50 node_id="a245c12d-995b-55ee-5ec7-aa36a6cad629",
51 property_overrides=[
52 ComponentInstanceNodePropertyOverridesWritePropertyOverridesItem(
53 property_id="7dd14c08-2e96-8d3d-2b19-b5c03642a0f0",
54 text="<div><h1>Time is an <em>illusion</em></h1></div>",
55 ),
56 ComponentInstanceNodePropertyOverridesWritePropertyOverridesItem(
57 property_id="7dd14c08-2e96-8d3d-2b19-b5c03642a0f1",
58 text="Life, the Universe and Everything",
59 ),
60 ],
61 ),
62 ],
63)

Returns: Updated page content confirmation

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