Forms

SDK reference for forms — Create and manage forms that can trigger graph executions.

Create and manage forms that can trigger graph executions.

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:

Parameter	Type	Required	Description
`projectId`	`string`	Yes
`id`	`string`	Yes

Output:

Field	Type	Description
`form`	`object`
`snapshot`	`object`

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

GET

Usage:

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

Input:

Parameter	Type	Required	Description
`projectId`	`string`	Yes
`pagination`	`object`	No

Output:

GET

Usage:

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

Input:

Parameter	Type	Required
`formId`	`string`	No
`formSnapshotId`	`string`	No
`pagination`	`object`	No

Output: