Get a Form
get
/public/v1/forms/{form}Returns the form's fields with the IDs and value formats a submission needs.
formstringrequiredThe form UUID
Response
200application/jsonFormResource
dataobjectrequired▶Show 10 child attributesHide child attributes
idstringrequiredExample:f1o2r3m4-a5b6-47c8-9d0e-1f2a3b4c5d6enamestringrequiredExample:Intake Formdescriptionstring | nullrequiredExample:Initial client intake questionnairestatusenum<string>requiredAvailable options:archivedpublishedunpublishedtypeenum<string>requiredAvailable options:externalinternalusageenum<string>requiredAvailable options:feedbackgeneraljob_applicationparticipant_incidentreferralregisterstaff_incidenthosted_urlstringrequiredExample:https://app.astalty.com.au/form/f1o2r3m4-a5b6-47c8-9d0e-1f2a3b4c5d6earchived_atstring | nullrequiredExample:2024-01-15T10:30:00+00:00created_atstringrequiredExample:2024-01-15T10:30:00+00:00fieldsobject[]required▶Show 10 child attributesHide child attributes
idstringrequiredExample:f1e2l3d4-a5b6-47c8-9d0e-1f2a3b4c5d6elabelstring | nullrequiredExample:Date of birthcontentstring | nullrequiredExample:Section heading or rich text contenttypeenum<string>requiredAvailable options:addressannotated_imagecheckboxdatedatetimedivideremailfileheaderimagelinear_scalemobile_phonemoneymultiselectnumberparticipant_selectradiorepeaterrich_textselectsite_selecttexttextareauser_selectfillablebooleanrequiredExample:truerequiredbooleanrequiredExample:falseoptionsstring[]requiredrepeater_fieldsobject[]required▶Show 2 child attributesHide child attributes
keyenum<string>requiredAvailable options:contactnamelabelstringrequiredExample:Full name
conditionsobject[]required▶Show 4 child attributesHide child attributes
effectenum<string>requiredAvailable options:requiredvisibilitysource_field_idstringrequiredExample:f1e2l3d4-a5b6-47c8-9d0e-1f2a3b4c5d6eoperatorenum<string>requiredAvailable options:afterbeforecontainsequalsgreater_thanis_checkedis_emptyis_not_checkedis_not_emptyless_thannot_equalsvaluestring | nullrequiredExample:Yes
value_formatstring | enum<string> | nullrequiredExample:One of the strings in options. Not an option ID.
401Unauthenticated403Authorization error404Not found