Skip to main content

Form Object

FieldTypeDescription
idIntegerUnique ID of the form.
template_version_idIntegerUnique ID of the template version of the template the form is made from.
agency_idIntegerUnique ID of the agency the form belongs to.
user_idIntegerUnique ID of the user that created the form.
nameStringName of the form.
templateBooleanReturns true if the form is a template.
finalisedBooleanReturns true if the form is finalised.
privateBooleanReturns true if the form is private.
createdTimestampReturns Unix timestamp of when form was created.
updatedTimestampReturns Unix timestamp of when form was updated.
template_costIntegerMonetary value of the form's template in cents.
template_instruction_pagesIntegerNumber of instruction pages in the form's template.
template_idIntegerUnique ID of the form's template.
template_nameIntegerName of the form's template.
template_orientationStringOrientation of the form's template.
annexure_template_idsArrayAn array of template ID's annexured to the form
annexure_pdf_idsArrayAn array of pdf ID's annexured to the form
values.*IntegerValues contained in the template.