Skip to content

Forms API

List a form's versions

GEThttps://email.growthdept.ai/api/forms/{id}/form-versions

Sort by created_at, updated_at, ascending or descending (put - in front).

Rate limits

Burst: 3/s

Steady: 60/m

Tier S. See rate limits for how requests are counted.

Scopes

forms:read

Operation id

get_versions_for_form The same operation as in Klaviyo's API. OpenAPI document

Path parameters

stringrequired

Query parameters

array of strings

Attributes of form-version resources to return.

Sparse fieldsets guide

Pick values to add them to the request:

string

Filter expression.

Filtering guide

Fields and the operators each one takes:

  • form_type: any, equals
  • status: equals
  • created_at: greater-or-equal, greater-than, less-or-equal, less-than
  • updated_at: greater-or-equal, greater-than, less-or-equal, less-than

string

From links.next or links.prev of the previous page.

Pagination guide

integer1 to 100default 20

Default 20, at most 100.

Pagination guide

string

Default created_at.

Sorting guide

Headers

stringrequireddefault 2026-10-15

API revision, YYYY-MM-DD. This server implements 2026-10-15.

Revisions guide

Responses

200Success

Response body

object

  • dataarray of objectsrequired

    data: 5 fields
    • typestringrequired

      form-version
    • idstringrequired

    • attributesobjectrequired

      attributes: 6 fields
      • form_typestringrequired

        bannerembedflyoutfull_pagepopup
      • variation_namestringrequired

      • ab_testobjectcan be null

        ab_test: 1 field
        • variation_namestringrequired

      • statusstringrequired

        draftlive
      • created_atstring (date-time)required

      • updated_atstring (date-time)required

    • relationshipsobject

      relationships: 1 field
      • formobject

        form: 2 fields
        • dataobject

          data: 2 fields
          • typestringrequired

            form
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

    • linksobjectrequired

      links: 1 field
      • selfstring (uri)required

  • linksobject

    links: 3 fields
    • selfstring (uri)required

    • prevstring (uri)

    • nextstring (uri)

  • metaobject

4XXClient error

Response body

object

  • errorsarray of objectsrequired

    errors: 8 fields
    • idstringrequired

    • statusintegerrequired

    • codestringrequired

    • titlestringrequired

    • detailstringrequired

    • sourceobject

      source: 2 fields
      • pointerstring

      • parameterstring

    • linksobject

    • metaobject

See status codes for each code.

5XXServer error

Response body

object

  • errorsarray of objectsrequired

    errors: 8 fields
    • idstringrequired

    • statusintegerrequired

    • codestringrequired

    • titlestringrequired

    • detailstringrequired

    • sourceobject

      source: 2 fields
      • pointerstring

      • parameterstring

    • linksobject

    • metaobject