Qodex.ai

Get Form

GET {{baseUrl}}/api/forms/:id/

Get the form with the given ID.

Rate limits:
Burst: 3/s
Steady: 60/m

Scopes: forms:read

Request Params

KeyDatatypeRequiredDescription
fields[form-version]stringFor more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
fields[form]stringFor more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
includestringFor more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships

HEADERS

KeyDatatypeRequiredDescription
revisionstring(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])
Acceptstring

RESPONSES

status: OK

{"data":{"type":"form","id":"\u003cstring\u003e","attributes":{"name":"\u003cstring\u003e","status":"draft","ab_test":"\u003cboolean\u003e","created_at":"\u003cdateTime\u003e","updated_at":"\u003cdateTime\u003e"},"links":{"self":"\u003curi\u003e"},"relationships":{"form-versions":{"data":[{"type":"form-version","id":"\u003cstring\u003e"},{"type":"form-version","id":"\u003cstring\u003e"}],"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}}}},"included":[{"type":"form-version","id":"\u003cstring\u003e","attributes":{"form_type":"popup","status":"live","created_at":"\u003cdateTime\u003e","updated_at":"\u003cdateTime\u003e","ab_test":{"variation_name":"\u003cstring\u003e"}},"links":{"self":"\u003curi\u003e"}},{"type":"form-version","id":"\u003cstring\u003e","attributes":{"form_type":"full_page","status":"live","created_at":"\u003cdateTime\u003e","updated_at":"\u003cdateTime\u003e","ab_test":{"variation_name":"\u003cstring\u003e"}},"links":{"self":"\u003curi\u003e"}}]}