Runtime Client

Use the runtime client directly when you want to call endpoints without composable state wrappers.

Main method groups

Schema and resolve

• getForm(key, options?)
• getFormVersions(key, options?)
• getFormVersion(key, version, options?)
• resolveForm(key, input?, options?)

Submission

• submitForm(key, input, options?)
• submitFormMultipart(key, formData, options?)
• stageUpload(key, input, options?)

Drafts

• saveDraft(key, input, options?)
• getCurrentDraft(key, options?)
• deleteCurrentDraft(key, options?)

Responses

• listResponses(key, query?, options?)
• getResponse(key, submissionId, options?)
• deleteResponse(key, submissionId, options?)

Management

• listForms(includeDeleted?, options?)
• createForm(input, options?)
• patchForm(key, input, options?)
• publishForm(key, options?)
• unpublishForm(key, options?)
• deleteForm(key, options?)
• getRevisions(key, includeDeleted?, options?)
• getDiff(key, fromVersion, toVersion, options?)

Categories

• listCategories(query?, options?)
• getCategory(categoryKey, options?)
• createCategory(input, options?)
• patchCategory(categoryKey, input, options?)
• deleteCategory(categoryKey, options?)