Forms

Manage forms, fields, and form submissions.

GET

Count what a form blocked, and why, over a recent window

/organizations/{organizationId}/projects/{projectId}/apps/forms/{appId}/forms/{formId}/blocked-submissions

Parameters

windowDays: query · integer
organizationIdRequired: path · string
projectIdRequired: path · string
appIdRequired: path · string
formIdRequired: path · string

SDK

1import { createGiantContext } from "@giantcontext/sdk-typescript";2
3const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });4
5const { organizations: orgs } = await gc.me.listMyOrganizations();6const { projects } = await gc.projects.listProjects({ organizationId: orgs[0].id });7const { apps } = await gc.projects.listProjectApps({8  organizationId: orgs[0].id,9  projectId: projects[0].id,10});11const { forms } = await gc.forms.listForms({12  organizationId: orgs[0].id,13  projectId: projects[0].id,14  appId: apps[0].id,15});16
17const { submissions } = await gc.forms.getFormBlockedSubmissions({18  organizationId: orgs[0].id,19  projectId: projects[0].id,20  appId: apps[0].id,21  formId: forms[0].id,22});23

GET

Get one form's fields, settings and content blocks in Builder format

/organizations/{organizationId}/projects/{projectId}/apps/forms/{appId}/forms/{formId}

Parameters

organizationIdRequired: path · string
projectIdRequired: path · string
appIdRequired: path · string
formIdRequired: path · string

SDK

1import { createGiantContext } from "@giantcontext/sdk-typescript";2
3const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });4
5const { organizations: orgs } = await gc.me.listMyOrganizations();6const { projects } = await gc.projects.listProjects({ organizationId: orgs[0].id });7const { apps } = await gc.projects.listProjectApps({8  organizationId: orgs[0].id,9  projectId: projects[0].id,10});11const { forms } = await gc.forms.listForms({12  organizationId: orgs[0].id,13  projectId: projects[0].id,14  appId: apps[0].id,15});16
17const { form } = await gc.forms.getForm({18  organizationId: orgs[0].id,19  projectId: projects[0].id,20  appId: apps[0].id,21  formId: forms[0].id,22});23

DELETE

Delete form

/organizations/{organizationId}/projects/{projectId}/apps/forms/{appId}/forms/{formId}

Parameters

organizationIdRequired: path · string
projectIdRequired: path · string
appIdRequired: path · string
formIdRequired: path · string

SDK

1import { createGiantContext } from "@giantcontext/sdk-typescript";2
3const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });4
5const { organizations: orgs } = await gc.me.listMyOrganizations();6const { projects } = await gc.projects.listProjects({ organizationId: orgs[0].id });7const { apps } = await gc.projects.listProjectApps({8  organizationId: orgs[0].id,9  projectId: projects[0].id,10});11const { forms } = await gc.forms.listForms({12  organizationId: orgs[0].id,13  projectId: projects[0].id,14  appId: apps[0].id,15});16
17const result = await gc.forms.deleteForm({18  organizationId: orgs[0].id,19  projectId: projects[0].id,20  appId: apps[0].id,21  formId: forms[0].id,22});23

PATCH

Update a form's name and description; cannot re-slug it or change fields

/organizations/{organizationId}/projects/{projectId}/apps/forms/{appId}/forms/{formId}

Parameters

organizationIdRequired: path · string
projectIdRequired: path · string
appIdRequired: path · string
formIdRequired: path · string

BodyRequired

name: stringInternal use only
settings: object
description: union

SDK

1import { createGiantContext } from "@giantcontext/sdk-typescript";2
3const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });4
5const { organizations: orgs } = await gc.me.listMyOrganizations();6const { projects } = await gc.projects.listProjects({ organizationId: orgs[0].id });7const { apps } = await gc.projects.listProjectApps({8  organizationId: orgs[0].id,9  projectId: projects[0].id,10});11const { forms } = await gc.forms.listForms({12  organizationId: orgs[0].id,13  projectId: projects[0].id,14  appId: apps[0].id,15});16
17const result = await gc.forms.updateFormMeta({18  organizationId: orgs[0].id,19  projectId: projects[0].id,20  appId: apps[0].id,21  formId: forms[0].id,22  data: {},23});24

GET

Get one submission's full answers plus its user agent, IP and referer

/organizations/{organizationId}/projects/{projectId}/apps/forms/{appId}/forms/{formId}/submissions/{submissionId}

Parameters

organizationIdRequired: path · string
projectIdRequired: path · string
appIdRequired: path · string
formIdRequired: path · string
submissionIdRequired: path · string

SDK

1import { createGiantContext } from "@giantcontext/sdk-typescript";2
3const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });4
5const { organizations: orgs } = await gc.me.listMyOrganizations();6const { projects } = await gc.projects.listProjects({ organizationId: orgs[0].id });7const { apps } = await gc.projects.listProjectApps({8  organizationId: orgs[0].id,9  projectId: projects[0].id,10});11const { forms } = await gc.forms.listForms({12  organizationId: orgs[0].id,13  projectId: projects[0].id,14  appId: apps[0].id,15});16const { submissions } = await gc.forms.listFormSubmissions({17  organizationId: orgs[0].id,18  projectId: projects[0].id,19  appId: apps[0].id,20  formId: forms[0].id,21});22
23const submission = await gc.forms.getFormSubmission({24  organizationId: orgs[0].id,25  projectId: projects[0].id,26  appId: apps[0].id,27  formId: forms[0].id,28  submissionId: submissions[0].id,29});30

GET

List one form's submissions, newest first, with submitted data and metadata

/organizations/{organizationId}/projects/{projectId}/apps/forms/{appId}/forms/{formId}/submissions

Parameters

page: query · number
pageSize: query · number
lite: query · string
sort: query · string
search: query · string
createdAt: query · string
organizationIdRequired: path · string
projectIdRequired: path · string
appIdRequired: path · string
formIdRequired: path · string

SDK

1import { createGiantContext } from "@giantcontext/sdk-typescript";2
3const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });4
5const { organizations: orgs } = await gc.me.listMyOrganizations();6const { projects } = await gc.projects.listProjects({ organizationId: orgs[0].id });7const { apps } = await gc.projects.listProjectApps({8  organizationId: orgs[0].id,9  projectId: projects[0].id,10});11const { forms } = await gc.forms.listForms({12  organizationId: orgs[0].id,13  projectId: projects[0].id,14  appId: apps[0].id,15});16
17const { submissions } = await gc.forms.listFormSubmissions({18  organizationId: orgs[0].id,19  projectId: projects[0].id,20  appId: apps[0].id,21  formId: forms[0].id,22});23

GET

List forms in a Forms app with their fields and submission counts, newest first

/organizations/{organizationId}/projects/{projectId}/apps/forms/{appId}/forms

Parameters

page: query · number
pageSize: query · number
lite: query · string
sort: query · string
search: query · string
slug: query · string
isActive: query · string
createdAt: query · string
updatedAt: query · string
organizationIdRequired: path · string
projectIdRequired: path · string
appIdRequired: path · string

SDK

1import { createGiantContext } from "@giantcontext/sdk-typescript";2
3const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });4
5const { organizations: orgs } = await gc.me.listMyOrganizations();6const { projects } = await gc.projects.listProjects({ organizationId: orgs[0].id });7const { apps } = await gc.projects.listProjectApps({8  organizationId: orgs[0].id,9  projectId: projects[0].id,10});11
12const { forms } = await gc.forms.listForms({13  organizationId: orgs[0].id,14  projectId: projects[0].id,15  appId: apps[0].id,16});17

BuiltAutonomously With AI

This content was built autonomously. Giant Context analyzed the site, determined what was missing, created and submitted an idea and draft, which Giant Context staff accepted and published.