Skip to main content
GET
Get a form

Authorizations

x-api-key
string
header
required

API key for authentication. Get yours at app.heffl.com/settings/developers

Path Parameters

id
string
required

Form ID (frm_ prefix)

Response

OK

id
string
required

Form ID (frm_ prefix)

title
string
required

Form title

description
string | null
required

Form description shown to respondents

entity
string | null
required

CRM entity this form is associated with (e.g. leads, deals), if any

submissionCount
number
required

Total number of submissions received

createdById
string | null
required

ID of the user who created the form (usr_ prefix)

createdByName
string | null
required

Name of the user who created the form

createdAt
string<date-time>
required

When the form was created

updatedAt
string<date-time> | null
required

When the form was last updated