Skip to content

HighLevel: Forms schemas

8 HighLevel schemas with complete fields and constraints.

← Forms operations · All schemas

Get Forms Submissions — response body

FieldTypePresenceDescription and constraints
$objectRoot
metaModelOptionalExpand Get Forms Submissions — response body — meta
submissionsarrayOptional
submissions[]ModelEach itemExpand Get Forms Submissions — response body — submissions item

Referenced models: Get Forms Submissions — response body — submissions item, Get Forms Submissions — response body — meta

Get Forms Submissions — response body — meta

FieldTypePresenceDescription and constraints
$objectRoot
currentPageJSONOptional
currentPage (anyOf 1)numberAlternative
currentPage (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
nextPageJSONOptional
nextPage (anyOf 1)JSONAlternative
nextPage (anyOf 1) (anyOf 1)numberAlternative
nextPage (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
nextPage (anyOf 2)nullAlternative
prevPageJSONOptional
prevPage (anyOf 1)JSONAlternative
prevPage (anyOf 1) (anyOf 1)numberAlternative
prevPage (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
prevPage (anyOf 2)nullAlternative
totalJSONOptional
total (anyOf 1)numberAlternative
total (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get Forms Submissions — response body — submissions item

FieldTypePresenceDescription and constraints
$objectRoot
contactIdstringOptional
createdAtstringOptional
emailstringOptional
formIdstringOptional
idstringOptional
namestringOptional
othersModelOptionalExpand Get Forms Submissions — response body — submissions item others

Referenced models: Get Forms Submissions — response body — submissions item others

Get Forms Submissions — response body — submissions item others

FieldTypePresenceDescription and constraints
$objectRoot
__custom_field_id__stringOptional
__submissions_other_field__stringOptional
eventDataModelOptionalExpand Get Forms Submissions — response body — submissions item others event Data
fieldsOriSequancearrayOptional
fieldsOriSequance[]stringEach item

Referenced models: Get Forms Submissions — response body — submissions item others event Data

Get Forms Submissions — response body — submissions item others event Data

FieldTypePresenceDescription and constraints
$objectRoot
adSourcestringOptional
contactSessionIdsJSONOptional
contactSessionIds (anyOf 1)JSONAlternative
contactSessionIds (anyOf 1) (allOf 1)ModelAll variants applyExpand Get Forms Submissions — response body — submissions item others event Data contact Session Ids ids ids
contactSessionIds (anyOf 2)nullAlternative
domainstringOptional
fbEventIdstringOptional
fbcstringOptional
fbpstringOptional
fingerprintstringOptional
mediumstringOptional
mediumIdstringOptional
pageModelOptionalExpand Get Forms Submissions — response body — submissions item others event Data page
pageVisitTypestringOptional
parentIdstringOptional
parentNamestringOptional
referrerstringOptional
sourcestringOptional
timestampJSONOptional
timestamp (anyOf 1)numberAlternative
timestamp (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
typestringOptional
versionstringOptional

Referenced models: Get Forms Submissions — response body — submissions item others event Data contact Session Ids ids ids, Get Forms Submissions — response body — submissions item others event Data page

Get Forms Submissions — response body — submissions item others event Data contact Session Ids ids ids

FieldTypePresenceDescription and constraints
$objectRoot
idsJSONOptional
ids (anyOf 1)arrayAlternative
ids (anyOf 1)[]stringEach item
ids (anyOf 2)nullAlternative

Get Forms Submissions — response body — submissions item others event Data page

FieldTypePresenceDescription and constraints
$objectRoot
titlestringOptional
urlstringOptional

Get Forms — response body

FieldTypePresenceDescription and constraints
$objectRoot
formsarrayOptional
forms[]ModelEach itemExpand Create Tag — response body — tag
totalJSONOptional
total (anyOf 1)numberAlternativeTotal number of forms
total (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Create Tag — response body — tag

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.