webflow-api 3.2.1 → 3.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.mock/definition/__package__.yml +20 -20
- package/.mock/definition/accessGroups.yml +12 -5
- package/.mock/definition/assets.yml +7 -4
- package/.mock/definition/collections/items.yml +14 -16
- package/.mock/definition/collections.yml +3 -0
- package/.mock/definition/comments.yml +1 -0
- package/.mock/definition/components.yml +16 -12
- package/.mock/definition/forms.yml +15 -88
- package/.mock/definition/items.yml +1 -0
- package/.mock/definition/orders.yml +82 -4
- package/.mock/definition/pages.yml +17 -8
- package/.mock/definition/products.yml +4 -4
- package/.mock/definition/scripts.yml +5 -1
- package/.mock/definition/sites/activityLogs.yml +8 -4
- package/.mock/definition/sites/comments.yml +14 -12
- package/.mock/definition/sites/forms.yml +316 -0
- package/.mock/definition/sites/scripts.yml +5 -4
- package/.mock/definition/sites.yml +24 -0
- package/.mock/definition/users.yml +66 -14
- package/.mock/definition/webhooks.yml +4 -0
- package/.mock/definition/workspaces/auditLogs.yml +4 -4
- package/.mock/fern.config.json +1 -1
- package/Client.js +2 -2
- package/LICENSE +21 -0
- package/api/resources/accessGroups/client/Client.d.ts +4 -2
- package/api/resources/accessGroups/client/Client.js +4 -2
- package/api/resources/accessGroups/client/requests/AccessGroupsListRequest.d.ts +2 -2
- package/api/resources/assets/client/Client.d.ts +2 -2
- package/api/resources/assets/client/Client.js +2 -2
- package/api/resources/assets/client/requests/AssetsListRequest.d.ts +2 -2
- package/api/resources/collections/resources/items/client/Client.d.ts +10 -12
- package/api/resources/collections/resources/items/client/Client.js +10 -12
- package/api/resources/collections/resources/items/client/requests/ItemsListItemsLiveRequest.d.ts +2 -2
- package/api/resources/collections/resources/items/client/requests/ItemsListItemsRequest.d.ts +2 -2
- package/api/resources/components/client/Client.d.ts +6 -6
- package/api/resources/components/client/Client.js +6 -6
- package/api/resources/components/client/requests/ComponentsGetContentRequest.d.ts +2 -2
- package/api/resources/components/client/requests/ComponentsGetPropertiesRequest.d.ts +2 -2
- package/api/resources/components/client/requests/ComponentsListRequest.d.ts +2 -2
- package/api/resources/forms/client/Client.d.ts +4 -31
- package/api/resources/forms/client/Client.js +4 -131
- package/api/resources/forms/client/requests/FormsListRequest.d.ts +2 -2
- package/api/resources/forms/client/requests/FormsListSubmissionsRequest.d.ts +2 -2
- package/api/resources/forms/client/requests/index.d.ts +0 -1
- package/api/resources/orders/client/Client.d.ts +2 -2
- package/api/resources/orders/client/Client.js +2 -2
- package/api/resources/orders/client/requests/OrdersListRequest.d.ts +2 -2
- package/api/resources/pages/client/Client.d.ts +4 -4
- package/api/resources/pages/client/Client.js +4 -4
- package/api/resources/pages/client/requests/PagesGetContentRequest.d.ts +2 -2
- package/api/resources/pages/client/requests/PagesListRequest.d.ts +2 -2
- package/api/resources/products/client/Client.d.ts +2 -2
- package/api/resources/products/client/Client.js +2 -2
- package/api/resources/products/client/requests/ProductsListRequest.d.ts +2 -2
- package/api/resources/sites/client/Client.d.ts +3 -0
- package/api/resources/sites/client/Client.js +5 -0
- package/api/resources/sites/resources/activityLogs/client/Client.d.ts +2 -2
- package/api/resources/sites/resources/activityLogs/client/Client.js +2 -2
- package/api/resources/sites/resources/activityLogs/client/requests/ActivityLogsListRequest.d.ts +2 -2
- package/api/resources/sites/resources/comments/client/Client.d.ts +6 -6
- package/api/resources/sites/resources/comments/client/Client.js +6 -6
- package/api/resources/sites/resources/comments/client/requests/CommentsGetCommentThreadRequest.d.ts +2 -2
- package/api/resources/sites/resources/comments/client/requests/CommentsListCommentRepliesRequest.d.ts +2 -2
- package/api/resources/sites/resources/comments/client/requests/CommentsListCommentThreadsRequest.d.ts +2 -2
- package/api/resources/sites/resources/forms/client/Client.d.ts +157 -0
- package/api/resources/sites/resources/forms/client/Client.js +662 -0
- package/api/resources/sites/resources/forms/client/index.d.ts +2 -0
- package/api/resources/sites/resources/forms/client/index.js +17 -0
- package/api/resources/{forms → sites/resources/forms}/client/requests/FormsListSubmissionsBySiteRequest.d.ts +2 -2
- package/api/resources/sites/resources/forms/client/requests/FormsListSubmissionsRequest.d.ts +20 -0
- package/api/resources/sites/resources/forms/client/requests/FormsUpdateSubmissionRequest.d.ts +11 -0
- package/api/resources/sites/resources/forms/client/requests/FormsUpdateSubmissionRequest.js +5 -0
- package/api/resources/sites/resources/forms/client/requests/index.d.ts +3 -0
- package/api/resources/sites/resources/forms/client/requests/index.js +2 -0
- package/api/resources/sites/resources/forms/index.d.ts +1 -0
- package/api/resources/sites/resources/forms/index.js +17 -0
- package/api/resources/sites/resources/index.d.ts +2 -0
- package/api/resources/sites/resources/index.js +3 -1
- package/api/resources/sites/resources/scripts/client/Client.d.ts +2 -2
- package/api/resources/sites/resources/scripts/client/Client.js +2 -2
- package/api/resources/sites/resources/scripts/client/requests/ScriptsListCustomCodeBlocksRequest.d.ts +2 -2
- package/api/resources/users/client/Client.d.ts +12 -2
- package/api/resources/users/client/Client.js +12 -2
- package/api/resources/users/client/requests/UsersListRequest.d.ts +2 -2
- package/api/resources/workspaces/resources/auditLogs/client/Client.d.ts +2 -2
- package/api/resources/workspaces/resources/auditLogs/client/Client.js +2 -2
- package/api/resources/workspaces/resources/auditLogs/client/requests/AuditLogsGetWorkspaceAuditLogsRequest.d.ts +2 -2
- package/dist/Client.js +2 -2
- package/dist/api/resources/accessGroups/client/Client.d.ts +4 -2
- package/dist/api/resources/accessGroups/client/Client.js +4 -2
- package/dist/api/resources/accessGroups/client/requests/AccessGroupsListRequest.d.ts +2 -2
- package/dist/api/resources/assets/client/Client.d.ts +2 -2
- package/dist/api/resources/assets/client/Client.js +2 -2
- package/dist/api/resources/assets/client/requests/AssetsListRequest.d.ts +2 -2
- package/dist/api/resources/collections/resources/items/client/Client.d.ts +10 -12
- package/dist/api/resources/collections/resources/items/client/Client.js +10 -12
- package/dist/api/resources/collections/resources/items/client/requests/ItemsListItemsLiveRequest.d.ts +2 -2
- package/dist/api/resources/collections/resources/items/client/requests/ItemsListItemsRequest.d.ts +2 -2
- package/dist/api/resources/components/client/Client.d.ts +6 -6
- package/dist/api/resources/components/client/Client.js +6 -6
- package/dist/api/resources/components/client/requests/ComponentsGetContentRequest.d.ts +2 -2
- package/dist/api/resources/components/client/requests/ComponentsGetPropertiesRequest.d.ts +2 -2
- package/dist/api/resources/components/client/requests/ComponentsListRequest.d.ts +2 -2
- package/dist/api/resources/forms/client/Client.d.ts +4 -31
- package/dist/api/resources/forms/client/Client.js +4 -131
- package/dist/api/resources/forms/client/requests/FormsListRequest.d.ts +2 -2
- package/dist/api/resources/forms/client/requests/FormsListSubmissionsRequest.d.ts +2 -2
- package/dist/api/resources/forms/client/requests/index.d.ts +0 -1
- package/dist/api/resources/orders/client/Client.d.ts +2 -2
- package/dist/api/resources/orders/client/Client.js +2 -2
- package/dist/api/resources/orders/client/requests/OrdersListRequest.d.ts +2 -2
- package/dist/api/resources/pages/client/Client.d.ts +4 -4
- package/dist/api/resources/pages/client/Client.js +4 -4
- package/dist/api/resources/pages/client/requests/PagesGetContentRequest.d.ts +2 -2
- package/dist/api/resources/pages/client/requests/PagesListRequest.d.ts +2 -2
- package/dist/api/resources/products/client/Client.d.ts +2 -2
- package/dist/api/resources/products/client/Client.js +2 -2
- package/dist/api/resources/products/client/requests/ProductsListRequest.d.ts +2 -2
- package/dist/api/resources/sites/client/Client.d.ts +3 -0
- package/dist/api/resources/sites/client/Client.js +5 -0
- package/dist/api/resources/sites/resources/activityLogs/client/Client.d.ts +2 -2
- package/dist/api/resources/sites/resources/activityLogs/client/Client.js +2 -2
- package/dist/api/resources/sites/resources/activityLogs/client/requests/ActivityLogsListRequest.d.ts +2 -2
- package/dist/api/resources/sites/resources/comments/client/Client.d.ts +6 -6
- package/dist/api/resources/sites/resources/comments/client/Client.js +6 -6
- package/dist/api/resources/sites/resources/comments/client/requests/CommentsGetCommentThreadRequest.d.ts +2 -2
- package/dist/api/resources/sites/resources/comments/client/requests/CommentsListCommentRepliesRequest.d.ts +2 -2
- package/dist/api/resources/sites/resources/comments/client/requests/CommentsListCommentThreadsRequest.d.ts +2 -2
- package/dist/api/resources/sites/resources/forms/client/Client.d.ts +157 -0
- package/dist/api/resources/sites/resources/forms/client/Client.js +662 -0
- package/dist/api/resources/sites/resources/forms/client/index.d.ts +2 -0
- package/dist/api/resources/sites/resources/forms/client/index.js +17 -0
- package/dist/api/resources/{forms → sites/resources/forms}/client/requests/FormsListSubmissionsBySiteRequest.d.ts +2 -2
- package/dist/api/resources/sites/resources/forms/client/requests/FormsListSubmissionsBySiteRequest.js +5 -0
- package/dist/api/resources/sites/resources/forms/client/requests/FormsListSubmissionsRequest.d.ts +20 -0
- package/dist/api/resources/sites/resources/forms/client/requests/FormsListSubmissionsRequest.js +5 -0
- package/dist/api/resources/sites/resources/forms/client/requests/FormsUpdateSubmissionRequest.d.ts +11 -0
- package/dist/api/resources/sites/resources/forms/client/requests/FormsUpdateSubmissionRequest.js +5 -0
- package/dist/api/resources/sites/resources/forms/client/requests/index.d.ts +3 -0
- package/dist/api/resources/sites/resources/forms/client/requests/index.js +2 -0
- package/dist/api/resources/sites/resources/forms/index.d.ts +1 -0
- package/dist/api/resources/sites/resources/forms/index.js +17 -0
- package/dist/api/resources/sites/resources/index.d.ts +2 -0
- package/dist/api/resources/sites/resources/index.js +3 -1
- package/dist/api/resources/sites/resources/scripts/client/Client.d.ts +2 -2
- package/dist/api/resources/sites/resources/scripts/client/Client.js +2 -2
- package/dist/api/resources/sites/resources/scripts/client/requests/ScriptsListCustomCodeBlocksRequest.d.ts +2 -2
- package/dist/api/resources/users/client/Client.d.ts +12 -2
- package/dist/api/resources/users/client/Client.js +12 -2
- package/dist/api/resources/users/client/requests/UsersListRequest.d.ts +2 -2
- package/dist/api/resources/workspaces/resources/auditLogs/client/Client.d.ts +2 -2
- package/dist/api/resources/workspaces/resources/auditLogs/client/Client.js +2 -2
- package/dist/api/resources/workspaces/resources/auditLogs/client/requests/AuditLogsGetWorkspaceAuditLogsRequest.d.ts +2 -2
- package/dist/serialization/resources/sites/resources/forms/client/index.d.ts +1 -0
- package/dist/serialization/resources/sites/resources/forms/client/index.js +17 -0
- package/dist/serialization/resources/sites/resources/forms/client/requests/FormsUpdateSubmissionRequest.d.ts +12 -0
- package/dist/serialization/resources/sites/resources/forms/client/requests/FormsUpdateSubmissionRequest.js +43 -0
- package/dist/serialization/resources/sites/resources/forms/client/requests/index.d.ts +1 -0
- package/dist/serialization/resources/sites/resources/forms/client/requests/index.js +5 -0
- package/dist/serialization/resources/sites/resources/forms/index.d.ts +1 -0
- package/dist/serialization/resources/sites/resources/forms/index.js +17 -0
- package/dist/serialization/resources/sites/resources/index.d.ts +2 -0
- package/dist/serialization/resources/sites/resources/index.js +3 -1
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/dist/wrapper/FormsClient.d.ts +37 -0
- package/dist/wrapper/FormsClient.js +193 -0
- package/dist/wrapper/ItemsClient.js +18 -14
- package/dist/wrapper/PagesClient.js +6 -5
- package/dist/wrapper/WebflowClient.d.ts +3 -0
- package/dist/wrapper/WebflowClient.js +6 -5
- package/jest.config.mjs +26 -5
- package/package.json +3 -2
- package/reference.md +458 -125
- package/serialization/resources/sites/resources/forms/client/index.d.ts +1 -0
- package/serialization/resources/sites/resources/forms/client/index.js +17 -0
- package/serialization/resources/sites/resources/forms/client/requests/FormsUpdateSubmissionRequest.d.ts +12 -0
- package/serialization/resources/sites/resources/forms/client/requests/FormsUpdateSubmissionRequest.js +43 -0
- package/serialization/resources/sites/resources/forms/client/requests/index.d.ts +1 -0
- package/serialization/resources/sites/resources/forms/client/requests/index.js +5 -0
- package/serialization/resources/sites/resources/forms/index.d.ts +1 -0
- package/serialization/resources/sites/resources/forms/index.js +17 -0
- package/serialization/resources/sites/resources/index.d.ts +2 -0
- package/serialization/resources/sites/resources/index.js +3 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/wrapper/FormsClient.d.ts +37 -0
- package/wrapper/FormsClient.js +193 -0
- package/wrapper/ItemsClient.js +18 -14
- package/wrapper/PagesClient.js +6 -5
- package/wrapper/WebflowClient.d.ts +3 -0
- package/wrapper/WebflowClient.js +6 -5
- /package/api/resources/{forms → sites/resources/forms}/client/requests/FormsListSubmissionsBySiteRequest.js +0 -0
- /package/{dist/api/resources/forms/client/requests/FormsListSubmissionsBySiteRequest.js → api/resources/sites/resources/forms/client/requests/FormsListSubmissionsRequest.js} +0 -0
|
@@ -657,15 +657,15 @@ types:
|
|
|
657
657
|
docs: Pagination object
|
|
658
658
|
properties:
|
|
659
659
|
limit:
|
|
660
|
-
type: optional<
|
|
660
|
+
type: optional<integer>
|
|
661
661
|
docs: The limit used for pagination
|
|
662
662
|
access: read-only
|
|
663
663
|
offset:
|
|
664
|
-
type: optional<
|
|
664
|
+
type: optional<integer>
|
|
665
665
|
docs: The offset used for pagination
|
|
666
666
|
access: read-only
|
|
667
667
|
total:
|
|
668
|
-
type: optional<
|
|
668
|
+
type: optional<integer>
|
|
669
669
|
docs: The total number of records
|
|
670
670
|
access: read-only
|
|
671
671
|
source:
|
|
@@ -1243,15 +1243,15 @@ types:
|
|
|
1243
1243
|
CollectionItemListPagination:
|
|
1244
1244
|
properties:
|
|
1245
1245
|
limit:
|
|
1246
|
-
type: optional<
|
|
1246
|
+
type: optional<integer>
|
|
1247
1247
|
docs: The limit specified in the request
|
|
1248
1248
|
default: 100
|
|
1249
1249
|
offset:
|
|
1250
|
-
type: optional<
|
|
1250
|
+
type: optional<integer>
|
|
1251
1251
|
docs: The offset specified for pagination
|
|
1252
1252
|
default: 0
|
|
1253
1253
|
total:
|
|
1254
|
-
type: optional<
|
|
1254
|
+
type: optional<integer>
|
|
1255
1255
|
docs: Total number of items in the collection
|
|
1256
1256
|
source:
|
|
1257
1257
|
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
@@ -1563,15 +1563,15 @@ types:
|
|
|
1563
1563
|
CommentThreadListPagination:
|
|
1564
1564
|
properties:
|
|
1565
1565
|
limit:
|
|
1566
|
-
type:
|
|
1566
|
+
type: integer
|
|
1567
1567
|
docs: The limit specified in the request (default 100)
|
|
1568
1568
|
default: 100
|
|
1569
1569
|
offset:
|
|
1570
|
-
type:
|
|
1570
|
+
type: integer
|
|
1571
1571
|
docs: The offset specified for pagination
|
|
1572
1572
|
default: 0
|
|
1573
1573
|
total:
|
|
1574
|
-
type:
|
|
1574
|
+
type: integer
|
|
1575
1575
|
docs: Total number of comment threads
|
|
1576
1576
|
source:
|
|
1577
1577
|
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
@@ -1664,15 +1664,15 @@ types:
|
|
|
1664
1664
|
CommentReplyListPagination:
|
|
1665
1665
|
properties:
|
|
1666
1666
|
limit:
|
|
1667
|
-
type:
|
|
1667
|
+
type: integer
|
|
1668
1668
|
docs: The limit specified in the request (default 100)
|
|
1669
1669
|
default: 100
|
|
1670
1670
|
offset:
|
|
1671
|
-
type:
|
|
1671
|
+
type: integer
|
|
1672
1672
|
docs: The offset specified for pagination
|
|
1673
1673
|
default: 0
|
|
1674
1674
|
total:
|
|
1675
|
-
type:
|
|
1675
|
+
type: integer
|
|
1676
1676
|
docs: Total number of comment replies
|
|
1677
1677
|
source:
|
|
1678
1678
|
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
@@ -2881,18 +2881,18 @@ types:
|
|
|
2881
2881
|
docs: The list users results
|
|
2882
2882
|
properties:
|
|
2883
2883
|
count:
|
|
2884
|
-
type: optional<
|
|
2884
|
+
type: optional<integer>
|
|
2885
2885
|
docs: Number of users returned
|
|
2886
2886
|
limit:
|
|
2887
|
-
type: optional<
|
|
2887
|
+
type: optional<integer>
|
|
2888
2888
|
docs: The limit specified in the request
|
|
2889
2889
|
default: 10
|
|
2890
2890
|
offset:
|
|
2891
|
-
type: optional<
|
|
2891
|
+
type: optional<integer>
|
|
2892
2892
|
docs: The offset specified for pagination
|
|
2893
2893
|
default: 0
|
|
2894
2894
|
total:
|
|
2895
|
-
type: optional<
|
|
2895
|
+
type: optional<integer>
|
|
2896
2896
|
docs: Total number of users in the collection
|
|
2897
2897
|
users:
|
|
2898
2898
|
type: optional<list<User>>
|
|
@@ -2929,18 +2929,18 @@ types:
|
|
|
2929
2929
|
docs: The list access groups results
|
|
2930
2930
|
properties:
|
|
2931
2931
|
count:
|
|
2932
|
-
type: optional<
|
|
2932
|
+
type: optional<integer>
|
|
2933
2933
|
docs: Number of access groups returned
|
|
2934
2934
|
limit:
|
|
2935
|
-
type: optional<
|
|
2935
|
+
type: optional<integer>
|
|
2936
2936
|
docs: The limit specified in the request
|
|
2937
2937
|
default: 10
|
|
2938
2938
|
offset:
|
|
2939
|
-
type: optional<
|
|
2939
|
+
type: optional<integer>
|
|
2940
2940
|
docs: The offset specified for pagination
|
|
2941
2941
|
default: 0
|
|
2942
2942
|
total:
|
|
2943
|
-
type: optional<
|
|
2943
|
+
type: optional<integer>
|
|
2944
2944
|
docs: Total number of access groups in the collection
|
|
2945
2945
|
accessGroups:
|
|
2946
2946
|
type: optional<list<AccessGroup>>
|
|
@@ -21,9 +21,15 @@ service:
|
|
|
21
21
|
auth:
|
|
22
22
|
- OAuth2:
|
|
23
23
|
- users:read
|
|
24
|
-
docs:
|
|
24
|
+
docs: >
|
|
25
|
+
<Warning>As of **January 29, 2026**, User Accounts functionality has
|
|
26
|
+
been disabled on all Webflow sites. This endpoint is no longer
|
|
27
|
+
available.</Warning>
|
|
28
|
+
|
|
29
|
+
|
|
25
30
|
Get a list of access groups for a site
|
|
26
31
|
|
|
32
|
+
|
|
27
33
|
Required scope | `users:read`
|
|
28
34
|
source:
|
|
29
35
|
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
@@ -36,12 +42,12 @@ service:
|
|
|
36
42
|
name: AccessGroupsListRequest
|
|
37
43
|
query-parameters:
|
|
38
44
|
offset:
|
|
39
|
-
type: optional<
|
|
45
|
+
type: optional<integer>
|
|
40
46
|
docs: >-
|
|
41
47
|
Offset used for pagination if the results have more than limit
|
|
42
48
|
records
|
|
43
49
|
limit:
|
|
44
|
-
type: optional<
|
|
50
|
+
type: optional<integer>
|
|
45
51
|
docs: 'Maximum number of records to be returned (max limit: 100)'
|
|
46
52
|
sort:
|
|
47
53
|
type: optional<AccessGroupsListRequestSort>
|
|
@@ -52,6 +58,7 @@ service:
|
|
|
52
58
|
docs: Request was successful
|
|
53
59
|
type: root.AccessGroupList
|
|
54
60
|
status-code: 200
|
|
61
|
+
availability: deprecated
|
|
55
62
|
errors:
|
|
56
63
|
- root.BadRequestError
|
|
57
64
|
- root.UnauthorizedError
|
|
@@ -63,8 +70,8 @@ service:
|
|
|
63
70
|
- path-parameters:
|
|
64
71
|
site_id: 580e63e98c9a982ac9b8b741
|
|
65
72
|
query-parameters:
|
|
66
|
-
offset: 1
|
|
67
|
-
limit: 1
|
|
73
|
+
offset: 1
|
|
74
|
+
limit: 1
|
|
68
75
|
sort: CreatedOn
|
|
69
76
|
response:
|
|
70
77
|
body:
|
|
@@ -25,12 +25,12 @@ service:
|
|
|
25
25
|
name: AssetsListRequest
|
|
26
26
|
query-parameters:
|
|
27
27
|
offset:
|
|
28
|
-
type: optional<
|
|
28
|
+
type: optional<integer>
|
|
29
29
|
docs: >-
|
|
30
30
|
Offset used for pagination if the results have more than limit
|
|
31
31
|
records
|
|
32
32
|
limit:
|
|
33
|
-
type: optional<
|
|
33
|
+
type: optional<integer>
|
|
34
34
|
docs: 'Maximum number of records to be returned (max limit: 100)'
|
|
35
35
|
response:
|
|
36
36
|
docs: Request was successful
|
|
@@ -46,8 +46,8 @@ service:
|
|
|
46
46
|
- path-parameters:
|
|
47
47
|
site_id: 580e63e98c9a982ac9b8b741
|
|
48
48
|
query-parameters:
|
|
49
|
-
offset: 1
|
|
50
|
-
limit: 1
|
|
49
|
+
offset: 1
|
|
50
|
+
limit: 1
|
|
51
51
|
response:
|
|
52
52
|
body:
|
|
53
53
|
assets:
|
|
@@ -242,6 +242,7 @@ service:
|
|
|
242
242
|
width: 500
|
|
243
243
|
height: 900
|
|
244
244
|
quality: 100
|
|
245
|
+
error: error
|
|
245
246
|
altText: A single candy wrapper
|
|
246
247
|
delete:
|
|
247
248
|
path: /assets/{asset_id}
|
|
@@ -335,6 +336,7 @@ service:
|
|
|
335
336
|
width: 500
|
|
336
337
|
height: 900
|
|
337
338
|
quality: 100
|
|
339
|
+
error: error
|
|
338
340
|
altText: A single candy wrapper
|
|
339
341
|
list-folders:
|
|
340
342
|
path: /sites/{site_id}/asset_folders
|
|
@@ -371,6 +373,7 @@ service:
|
|
|
371
373
|
assetFolders:
|
|
372
374
|
- id: 6390c49774a71f0e3c1a08ee
|
|
373
375
|
displayName: emoji icons
|
|
376
|
+
parentFolder: 6390c49774a71f99f21a08eb
|
|
374
377
|
assets:
|
|
375
378
|
- 63e5889e7fe4eafa7384cea4
|
|
376
379
|
- 659595234426a9fcbad57043
|
|
@@ -200,12 +200,12 @@ service:
|
|
|
200
200
|
response. To query multiple locales, input a comma separated
|
|
201
201
|
string.
|
|
202
202
|
offset:
|
|
203
|
-
type: optional<
|
|
203
|
+
type: optional<integer>
|
|
204
204
|
docs: >-
|
|
205
205
|
Offset used for pagination if the results have more than limit
|
|
206
206
|
records
|
|
207
207
|
limit:
|
|
208
|
-
type: optional<
|
|
208
|
+
type: optional<integer>
|
|
209
209
|
docs: 'Maximum number of records to be returned (max limit: 100)'
|
|
210
210
|
name:
|
|
211
211
|
type: optional<string>
|
|
@@ -237,8 +237,8 @@ service:
|
|
|
237
237
|
collection_id: 580e63fc8c9a982ac9b8b745
|
|
238
238
|
query-parameters:
|
|
239
239
|
cmsLocaleId: cmsLocaleId
|
|
240
|
-
offset: 1
|
|
241
|
-
limit: 1
|
|
240
|
+
offset: 1
|
|
241
|
+
limit: 1
|
|
242
242
|
name: name
|
|
243
243
|
slug: slug
|
|
244
244
|
sortBy: lastPublished
|
|
@@ -673,10 +673,9 @@ service:
|
|
|
673
673
|
docs: |
|
|
674
674
|
List all published items in a collection.
|
|
675
675
|
|
|
676
|
-
<
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
</Note>
|
|
676
|
+
<Tip title="Serve data with the Content Delivery API">
|
|
677
|
+
Serving data to applications in real-time? Use the Content Delivery API at `api-cdn.webflow.com` for better performance. The CDN-backed endpoint is optimized for high-volume reads, while the Data API is designed for writes and management operations.
|
|
678
|
+
</Tip>
|
|
680
679
|
|
|
681
680
|
Required scope | `CMS:read`
|
|
682
681
|
source:
|
|
@@ -697,12 +696,12 @@ service:
|
|
|
697
696
|
response. To query multiple locales, input a comma separated
|
|
698
697
|
string.
|
|
699
698
|
offset:
|
|
700
|
-
type: optional<
|
|
699
|
+
type: optional<integer>
|
|
701
700
|
docs: >-
|
|
702
701
|
Offset used for pagination if the results have more than limit
|
|
703
702
|
records
|
|
704
703
|
limit:
|
|
705
|
-
type: optional<
|
|
704
|
+
type: optional<integer>
|
|
706
705
|
docs: 'Maximum number of records to be returned (max limit: 100)'
|
|
707
706
|
name:
|
|
708
707
|
type: optional<string>
|
|
@@ -735,8 +734,8 @@ service:
|
|
|
735
734
|
collection_id: 580e63fc8c9a982ac9b8b745
|
|
736
735
|
query-parameters:
|
|
737
736
|
cmsLocaleId: cmsLocaleId
|
|
738
|
-
offset: 1
|
|
739
|
-
limit: 1
|
|
737
|
+
offset: 1
|
|
738
|
+
limit: 1
|
|
740
739
|
name: name
|
|
741
740
|
slug: slug
|
|
742
741
|
sortBy: lastPublished
|
|
@@ -1797,10 +1796,9 @@ service:
|
|
|
1797
1796
|
docs: |
|
|
1798
1797
|
Get details of a selected Collection live Item.
|
|
1799
1798
|
|
|
1800
|
-
<
|
|
1801
|
-
|
|
1802
|
-
|
|
1803
|
-
</Note>
|
|
1799
|
+
<Tip title="Serve data with the Content Delivery API">
|
|
1800
|
+
Serving data to applications in real-time? Use the Content Delivery API at `api-cdn.webflow.com` for better performance. The CDN-backed endpoint is optimized for high-volume reads, while the Data API is designed for writes and management operations.
|
|
1801
|
+
</Tip>
|
|
1804
1802
|
|
|
1805
1803
|
Required scope | `CMS:read`
|
|
1806
1804
|
source:
|
|
@@ -303,18 +303,21 @@ service:
|
|
|
303
303
|
type: File
|
|
304
304
|
slug: guide-file
|
|
305
305
|
displayName: Guide File
|
|
306
|
+
helpText: helpText
|
|
306
307
|
- id: 7f8e9d0c1b2a3f4e5d6c8b9e
|
|
307
308
|
isRequired: false
|
|
308
309
|
isEditable: true
|
|
309
310
|
type: Email
|
|
310
311
|
slug: contributor-email
|
|
311
312
|
displayName: Contributor Email
|
|
313
|
+
helpText: helpText
|
|
312
314
|
- id: 3a4f5e6d7c8b9a0e1d2c4b5f
|
|
313
315
|
isRequired: false
|
|
314
316
|
isEditable: true
|
|
315
317
|
type: Phone
|
|
316
318
|
slug: emergency-contact
|
|
317
319
|
displayName: Emergency Contact
|
|
320
|
+
helpText: helpText
|
|
318
321
|
delete:
|
|
319
322
|
path: /collections/{collection_id}
|
|
320
323
|
method: DELETE
|
|
@@ -17,6 +17,7 @@ webhooks:
|
|
|
17
17
|
siteId: 679826b3b20b045e176bc4b5
|
|
18
18
|
pageId: 679826b3b20b045e176bc4bc
|
|
19
19
|
localeId: 67993753d910db250db64b3e
|
|
20
|
+
itemId: 580e64008c9a982ac9b8b754
|
|
20
21
|
breakpoint: main
|
|
21
22
|
url: >-
|
|
22
23
|
https://webflow.com/design/site-slug-4ec832?workflow=comment&commentId=679d2ddb5196117ad04d1ffa&pageId=679826b3b20b045e176bc4bc
|
|
@@ -28,10 +28,10 @@ service:
|
|
|
28
28
|
type: optional<string>
|
|
29
29
|
docs: Scope the operation to work on a specific branch.
|
|
30
30
|
limit:
|
|
31
|
-
type: optional<
|
|
31
|
+
type: optional<integer>
|
|
32
32
|
docs: 'Maximum number of records to be returned (max limit: 100)'
|
|
33
33
|
offset:
|
|
34
|
-
type: optional<
|
|
34
|
+
type: optional<integer>
|
|
35
35
|
docs: >-
|
|
36
36
|
Offset used for pagination if the results have more than limit
|
|
37
37
|
records
|
|
@@ -50,8 +50,8 @@ service:
|
|
|
50
50
|
site_id: 580e63e98c9a982ac9b8b741
|
|
51
51
|
query-parameters:
|
|
52
52
|
branchId: 68026fa68ef6dc744c75b833
|
|
53
|
-
limit: 1
|
|
54
|
-
offset: 1
|
|
53
|
+
limit: 1
|
|
54
|
+
offset: 1
|
|
55
55
|
response:
|
|
56
56
|
body:
|
|
57
57
|
components:
|
|
@@ -69,9 +69,13 @@ service:
|
|
|
69
69
|
readonly: true
|
|
70
70
|
- id: 6258612d1ee792848f805dcf
|
|
71
71
|
name: Card
|
|
72
|
+
group: Buttons
|
|
73
|
+
description: A button component that can be used across the site
|
|
72
74
|
readonly: true
|
|
73
75
|
- id: 68a2b1d1ee792848f805dcf
|
|
74
76
|
name: Nav
|
|
77
|
+
group: Buttons
|
|
78
|
+
description: A button component that can be used across the site
|
|
75
79
|
readonly: true
|
|
76
80
|
pagination:
|
|
77
81
|
limit: 20
|
|
@@ -125,10 +129,10 @@ service:
|
|
|
125
129
|
type: optional<string>
|
|
126
130
|
docs: Scope the operation to work on a specific branch.
|
|
127
131
|
limit:
|
|
128
|
-
type: optional<
|
|
132
|
+
type: optional<integer>
|
|
129
133
|
docs: 'Maximum number of records to be returned (max limit: 100)'
|
|
130
134
|
offset:
|
|
131
|
-
type: optional<
|
|
135
|
+
type: optional<integer>
|
|
132
136
|
docs: >-
|
|
133
137
|
Offset used for pagination if the results have more than limit
|
|
134
138
|
records
|
|
@@ -149,8 +153,8 @@ service:
|
|
|
149
153
|
query-parameters:
|
|
150
154
|
localeId: 65427cf400e02b306eaa04a0
|
|
151
155
|
branchId: 68026fa68ef6dc744c75b833
|
|
152
|
-
limit: 1
|
|
153
|
-
offset: 1
|
|
156
|
+
limit: 1
|
|
157
|
+
offset: 1
|
|
154
158
|
response:
|
|
155
159
|
body:
|
|
156
160
|
componentId: 69118560-d0bc-15fc-bbf8-b8fe5f6535b5
|
|
@@ -353,10 +357,10 @@ service:
|
|
|
353
357
|
type: optional<string>
|
|
354
358
|
docs: Scope the operation to work on a specific branch.
|
|
355
359
|
limit:
|
|
356
|
-
type: optional<
|
|
360
|
+
type: optional<integer>
|
|
357
361
|
docs: 'Maximum number of records to be returned (max limit: 100)'
|
|
358
362
|
offset:
|
|
359
|
-
type: optional<
|
|
363
|
+
type: optional<integer>
|
|
360
364
|
docs: >-
|
|
361
365
|
Offset used for pagination if the results have more than limit
|
|
362
366
|
records
|
|
@@ -377,8 +381,8 @@ service:
|
|
|
377
381
|
query-parameters:
|
|
378
382
|
localeId: 65427cf400e02b306eaa04a0
|
|
379
383
|
branchId: 68026fa68ef6dc744c75b833
|
|
380
|
-
limit: 1
|
|
381
|
-
offset: 1
|
|
384
|
+
limit: 1
|
|
385
|
+
offset: 1
|
|
382
386
|
response:
|
|
383
387
|
body:
|
|
384
388
|
componentId: 658205daa3e8206a523b5ad4
|
|
@@ -25,10 +25,10 @@ service:
|
|
|
25
25
|
name: FormsListRequest
|
|
26
26
|
query-parameters:
|
|
27
27
|
limit:
|
|
28
|
-
type: optional<
|
|
28
|
+
type: optional<integer>
|
|
29
29
|
docs: 'Maximum number of records to be returned (max limit: 100)'
|
|
30
30
|
offset:
|
|
31
|
-
type: optional<
|
|
31
|
+
type: optional<integer>
|
|
32
32
|
docs: >-
|
|
33
33
|
Offset used for pagination if the results have more than limit
|
|
34
34
|
records
|
|
@@ -48,8 +48,8 @@ service:
|
|
|
48
48
|
- path-parameters:
|
|
49
49
|
site_id: 580e63e98c9a982ac9b8b741
|
|
50
50
|
query-parameters:
|
|
51
|
-
limit: 1
|
|
52
|
-
offset: 1
|
|
51
|
+
limit: 1
|
|
52
|
+
offset: 1
|
|
53
53
|
response:
|
|
54
54
|
body:
|
|
55
55
|
forms:
|
|
@@ -59,13 +59,16 @@ service:
|
|
|
59
59
|
fields:
|
|
60
60
|
'0':
|
|
61
61
|
displayName: Email
|
|
62
|
+
placeholder: Enter your email
|
|
62
63
|
userVisible: true
|
|
63
64
|
'1':
|
|
64
65
|
displayName: Email
|
|
66
|
+
placeholder: Enter your email
|
|
65
67
|
userVisible: true
|
|
66
68
|
responseSettings:
|
|
67
69
|
redirectUrl: https://example.com
|
|
68
70
|
redirectMethod: GET
|
|
71
|
+
redirectAction: POST https://example.com
|
|
69
72
|
sendEmailConfirmation: true
|
|
70
73
|
id: 589a331aa51e760df7ccb89e
|
|
71
74
|
siteId: 580e63e98c9a982ac9b8b741
|
|
@@ -80,10 +83,12 @@ service:
|
|
|
80
83
|
fields:
|
|
81
84
|
'0':
|
|
82
85
|
displayName: Email
|
|
86
|
+
placeholder: Enter your email
|
|
83
87
|
userVisible: true
|
|
84
88
|
responseSettings:
|
|
85
89
|
redirectUrl: https://example.com
|
|
86
90
|
redirectMethod: GET
|
|
91
|
+
redirectAction: POST https://example.com
|
|
87
92
|
sendEmailConfirmation: false
|
|
88
93
|
id: 580ff8d7ba3e45ba9fe588e9
|
|
89
94
|
siteId: 580e63e98c9a982ac9b8b741
|
|
@@ -136,6 +141,7 @@ service:
|
|
|
136
141
|
660d5bcc9c0772150459dfb1:
|
|
137
142
|
displayName: Name
|
|
138
143
|
type: Plain
|
|
144
|
+
placeholder: Enter your email
|
|
139
145
|
userVisible: true
|
|
140
146
|
589a331aa51e760df7ccb89d:
|
|
141
147
|
displayName: Email
|
|
@@ -145,6 +151,7 @@ service:
|
|
|
145
151
|
responseSettings:
|
|
146
152
|
redirectUrl: https://example.com
|
|
147
153
|
redirectMethod: GET
|
|
154
|
+
redirectAction: POST https://example.com
|
|
148
155
|
sendEmailConfirmation: true
|
|
149
156
|
id: 589a331aa51e760df7ccb89e
|
|
150
157
|
siteId: 580e63e98c9a982ac9b8b741
|
|
@@ -180,12 +187,12 @@ service:
|
|
|
180
187
|
name: FormsListSubmissionsRequest
|
|
181
188
|
query-parameters:
|
|
182
189
|
offset:
|
|
183
|
-
type: optional<
|
|
190
|
+
type: optional<integer>
|
|
184
191
|
docs: >-
|
|
185
192
|
Offset used for pagination if the results have more than limit
|
|
186
193
|
records
|
|
187
194
|
limit:
|
|
188
|
-
type: optional<
|
|
195
|
+
type: optional<integer>
|
|
189
196
|
docs: 'Maximum number of records to be returned (max limit: 100)'
|
|
190
197
|
response:
|
|
191
198
|
docs: Request was successful
|
|
@@ -202,8 +209,8 @@ service:
|
|
|
202
209
|
- path-parameters:
|
|
203
210
|
form_id: 580e63e98c9a982ac9b8b741
|
|
204
211
|
query-parameters:
|
|
205
|
-
offset: 1
|
|
206
|
-
limit: 1
|
|
212
|
+
offset: 1
|
|
213
|
+
limit: 1
|
|
207
214
|
response:
|
|
208
215
|
body:
|
|
209
216
|
formSubmissions:
|
|
@@ -350,86 +357,6 @@ service:
|
|
|
350
357
|
formResponse:
|
|
351
358
|
First Name: Arthur
|
|
352
359
|
Last Name: Dent
|
|
353
|
-
list-submissions-by-site:
|
|
354
|
-
path: /sites/{site_id}/form_submissions
|
|
355
|
-
method: GET
|
|
356
|
-
auth:
|
|
357
|
-
- OAuth2:
|
|
358
|
-
- forms:read
|
|
359
|
-
docs: >
|
|
360
|
-
List form submissions for a given site. This endpoint differs from the
|
|
361
|
-
existing [List Form Submissions
|
|
362
|
-
endpoint](/data/reference/forms/form-submissions/list-submissions) by
|
|
363
|
-
accepting `siteId` as a path parameter and `elementId` as a query
|
|
364
|
-
parameter. You can get the `elementId` from the [List forms
|
|
365
|
-
endpoint](/data/reference/forms/forms/list).
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
Required scope | `forms:read`
|
|
371
|
-
source:
|
|
372
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
373
|
-
path-parameters:
|
|
374
|
-
site_id:
|
|
375
|
-
type: string
|
|
376
|
-
docs: Unique identifier for a Site
|
|
377
|
-
display-name: List Form Submissions by Site
|
|
378
|
-
request:
|
|
379
|
-
name: FormsListSubmissionsBySiteRequest
|
|
380
|
-
query-parameters:
|
|
381
|
-
elementId:
|
|
382
|
-
type: optional<string>
|
|
383
|
-
docs: Identifier for an element
|
|
384
|
-
offset:
|
|
385
|
-
type: optional<double>
|
|
386
|
-
docs: >-
|
|
387
|
-
Offset used for pagination if the results have more than limit
|
|
388
|
-
records
|
|
389
|
-
limit:
|
|
390
|
-
type: optional<double>
|
|
391
|
-
docs: 'Maximum number of records to be returned (max limit: 100)'
|
|
392
|
-
response:
|
|
393
|
-
docs: Request was successful
|
|
394
|
-
type: root.FormSubmissionList
|
|
395
|
-
status-code: 200
|
|
396
|
-
errors:
|
|
397
|
-
- root.BadRequestError
|
|
398
|
-
- root.UnauthorizedError
|
|
399
|
-
- root.ForbiddenError
|
|
400
|
-
- root.NotFoundError
|
|
401
|
-
- root.TooManyRequestsError
|
|
402
|
-
- root.InternalServerError
|
|
403
|
-
examples:
|
|
404
|
-
- path-parameters:
|
|
405
|
-
site_id: 580e63e98c9a982ac9b8b741
|
|
406
|
-
query-parameters:
|
|
407
|
-
elementId: 18259716-3e5a-646a-5f41-5dc4b9405aa0
|
|
408
|
-
offset: 1.1
|
|
409
|
-
limit: 1.1
|
|
410
|
-
response:
|
|
411
|
-
body:
|
|
412
|
-
formSubmissions:
|
|
413
|
-
- id: 6321ca84df3949bfc6752327
|
|
414
|
-
displayName: Sample Form
|
|
415
|
-
siteId: 62749158efef318abc8d5a0f
|
|
416
|
-
workspaceId: 62749158efef318abc8d5a0f
|
|
417
|
-
dateSubmitted: '2022-09-14T12:35:16Z'
|
|
418
|
-
formResponse:
|
|
419
|
-
First Name: Arthur
|
|
420
|
-
Last Name: Dent
|
|
421
|
-
- id: 660d64fabf6e0a0d4edab981
|
|
422
|
-
displayName: Sample Form
|
|
423
|
-
siteId: 62749158efef318abc8d5a0f
|
|
424
|
-
workspaceId: 62749158efef318abc8d5a0f
|
|
425
|
-
dateSubmitted: '2022-09-14T12:35:16Z'
|
|
426
|
-
formResponse:
|
|
427
|
-
First Name: Ford
|
|
428
|
-
Last Name: Prefect
|
|
429
|
-
pagination:
|
|
430
|
-
limit: 25
|
|
431
|
-
offset: 0
|
|
432
|
-
total: 2
|
|
433
360
|
source:
|
|
434
361
|
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
435
362
|
display-name: Forms
|
|
@@ -83,6 +83,7 @@ webhooks:
|
|
|
83
83
|
siteId: 65427cf400e02b306eaa049c
|
|
84
84
|
workspaceId: 625860a7a6c16d624927122f
|
|
85
85
|
collectionId: 664243617fcc8b464b23c4ee
|
|
86
|
+
cmsLocaleId: 681442a144bb80bd00480fda
|
|
86
87
|
docs: Information about a collection item that was published
|
|
87
88
|
collection_item_unpublished:
|
|
88
89
|
audiences: []
|