SDKClient

Forms

SDK reference for forms — Read deployed form definitions and submissions.

Read deployed form definitions and submissions.

getForm

Get stable form identity and the preferred snapshot for the active deployment (or latest).

GET

Usage:

const result = await swirls.client.forms.getForm({
  projectId: '...',
  id: '...',
})

Input:

ParameterTypeRequiredDescription
projectIdstringYes
idstringYes

Output:

FieldTypeDescription
formobject
snapshotobject

listForms

List one row per stable form with preferred snapshot and version count.

GET

Usage:

const result = await swirls.client.forms.listForms({
  projectId: '...',
})

Input:

ParameterTypeRequiredDescription
projectIdstringYes
paginationobjectNo

Output:

FieldTypeDescription
paginationobject
resultsobject[]
totalCountnumber

listFormSubmissions

GET

Usage:

const result = await swirls.client.forms.listFormSubmissions({})

Input:

ParameterTypeRequiredDescription
formIdstringNo
formSnapshotIdstringNo
paginationobjectNo

Output:

FieldTypeDescription
paginationobject
resultsobject[]
totalCountnumber

On this page