Get Forms
GET {{baseUrl}}/api/forms/
Get all forms in an account.
Rate limits:
Burst: 3/s
Steady: 60/m
Scopes:
forms:read
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
fields[form] | string | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets | |
filter | string | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>id: any, equals<br>name: any, contains, equals<br>ab_test: equals<br>updated_at: greater-or-equal, greater-than, less-or-equal, less-than<br>created_at: greater-or-equal, greater-than, less-or-equal, less-than<br>status: equals | |
page[cursor] | string | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination | |
page[size] | number | Default: 20. Min: 1. Max: 100. | |
sort | string | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
revision | string | (Required) API endpoint revision (format: YYYY-MM-DD[.suffix]) | |
Accept | string |
RESPONSES
status: OK
{"data":[{"type":"form","id":"\u003cstring\u003e","attributes":{"name":"\u003cstring\u003e","status":"live","ab_test":"\u003cboolean\u003e","created_at":"\u003cdateTime\u003e","updated_at":"\u003cdateTime\u003e"},"links":{"self":"\u003curi\u003e"},"relationships":{"form-versions":{"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}}}},{"type":"form","id":"\u003cstring\u003e","attributes":{"name":"\u003cstring\u003e","status":"live","ab_test":"\u003cboolean\u003e","created_at":"\u003cdateTime\u003e","updated_at":"\u003cdateTime\u003e"},"links":{"self":"\u003curi\u003e"},"relationships":{"form-versions":{"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}}}}],"links":{"self":"\u003curi\u003e","first":"\u003curi\u003e","last":"\u003curi\u003e","prev":"\u003curi\u003e","next":"\u003curi\u003e"}}