Submission data model

Updated:

View field support, webhooks, and list parameters for each integration on the Supported Integrations page.

FieldTypeRequiredDescription
idstringNo
created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
form_idstringYes
respondent_emailstringNo
respondent_namestringNo
answersFormAnswer[]Yes
answers[].field_idstringYes
answers[].field_namestringNo
answers[].valuestringNoCan be string, number, boolean, array, etc.
answers[].file_idsstring[]Noreferences StorageFile ID
metadataFormsMetadata[]No
metadata[].idstringNo
metadata[].slugstringNo
metadata[].valueobjectNo
metadata[].namespacestringNo
metadata[].formatenumNoValues: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL
metadata[].extra_dataobjectNo

TypeScript

TypeScript
export type FormsSubmission = {
	id?: string;
	created_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	form_id: string;
	respondent_email?: string;
	respondent_name?: string;
	answers: [];
	metadata?: [];
	raw?: any;
} 

Zod

Zod
import { z } from 'zod';

export const ZodFormsSubmission = z.object({
	id: z.string().optional(),
	created_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	form_id: z.string(),
	respondent_email: z.string().optional(),
	respondent_name: z.string().optional(),
	answers: z.array(),
	metadata: z.array().optional(),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class FormsSubmission:
	id: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	form_id: str
	respondent_email: Optional[str]
	respondent_name: Optional[str]
	answers: PropertyFormsSubmissionAnswers
	metadata: Optional[PropertyFormsSubmissionMetadata]
Are we missing anything? Let us know
Was this page helpful?