Skip to main content
​
id
string

The form's unique identifier.

Example:

"for_01HQFQ9QWTNNPY58FZ8CB3FWWK"

​
client_id
string

The identifier of the client the form belongs to.

Example:

"cli_01HQFQ9QWTNNPY58FZ8CB3FWWK"

​
location_id
string | null

The identifier of the location the form is associated with.

Example:

"loc_01HZR88VXZ3G2NTVPEB2PCCKDY"

​
form_template_id
string

The identifier of the form template the form was created from.

Example:

"fte_01HYHYQHA682J0K1RW7B2HVA9F"

​
appointment_client_id
string | null

The identifier of the appointment client the form was created for.

Example:

"apc_01HYHYW37MTYJPMT5JV4RN99GK"

​
name
string

The form's name.

Example:

"Intake questionnaire"

​
color
string

The form's display colour.

Example:

"blue"

​
completion_message
string

The message shown to the client once the form is submitted.

Example:

"Thanks for completing your form."

​
prefill_client_fields
boolean

Whether the client's existing details are prefilled into the form.

Example:

true

​
override_client_fields
boolean

Whether submitting the form overwrites the client's existing details.

Example:

false

​
status
enum<string>

The form's completion status.

Available options:
not_started,
in_progress,
completed
Example:

"completed"

​
sent_status
string | null

The form's delivery status, or null if it has not been sent.

Example:

"viewed"

​
content
object[]

The form's pages, sections, questions and answers.

​
hosted_form_url
string

The URL the client uses to complete the form.

Example:

"https://example.caspen.com/form/for_01HQFQ9QWTNNPY58FZ8CB3FWWK"

​
sent_at
string | null

The timestamp when the form was sent to the client (ISO 8601).

Example:

"2024-01-01T12:00:00Z"

​
viewed_at
string | null

The timestamp when the client first viewed the form (ISO 8601).

Example:

"2024-01-01T13:00:00Z"

​
completed_at
string | null

The timestamp when the client completed the form (ISO 8601).

Example:

"2024-01-01T14:00:00Z"

​
archived_at
string | null

The timestamp when the form was archived (ISO 8601), or null if it is active.

Example:

"2024-02-01T09:00:00Z"

​
created_at
string

The timestamp when the form was created (ISO 8601).

Example:

"2024-01-01T12:00:00Z"