Skip to content

Forms API

List forms

GEThttps://email.growthdept.ai/api/forms

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_forms The same operation as in Klaviyo's API. OpenAPI document

Query parameters

array of strings

Attributes of form 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:

  • id: any, equals
  • name: any, contains, equals
  • ab_test: 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
    • idstringrequired

    • attributesobjectrequired

      attributes: 5 fields
      • namestringrequired

      • statusstringrequired

        draftlive
      • ab_testbooleanrequired

      • created_atstring (date-time)required

      • updated_atstring (date-time)required

    • relationshipsobject

      relationships: 1 field
      • form-versionsobject

        form-versions: 2 fields
        • dataarray of objects

          data: 2 fields
          • typestringrequired

            form-version
          • 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