Retrieve a Form Submission

GET

/businesses/{businessId}/form-submissions/{formSubmissionId}

• production

Retrieve a Form Submission by ID.

Authorizations

• apiKey

Parameters

Path Parameters

businessId

required

The ID of the Business.

string

formSubmissionId

required

The ID of the Form Submission.

string

Responses

200

A Form Submission.

object

data

Form Submission

A form submission created by a client when a form is submitted.

object

id

Unique identifier across the platform.

string format: uuid

formId

The unique identifier of the form that created this submission.

string

Example

form1

patientId

The unique identifier of the patient who submitted the form.

string

Example

patient1

patientVerified

Whether the patient was authenticated when submitting the form.

boolean

Example

true

appointmentId

If the form included a booking form then an appointment ID will be associated with the submission.

string

Example

appointment1

questions

Array<object>

object

id

The unique identifier of the question.

string

Example

patient-name

type

The type of the question (e.g., text, multiple choice).

string

Example

text

title

The title of the question.

string

patientKey

The key used to identify the question for the patient.

string

nullable

Example

patientName

answers

Array<object>

object

id

The ID that matches the question ID.

string

Example

patient-name

value

The answer provided by the patient.

string

Example

Jane Doe

createdAt

The date and time when the form submission was created.

string format: date-time

startedAt

The date and time when the form submission was started.

string format: date-time

completedAt

The date and time when the form submission was submitted.

string format: date-time

404

Form Submission not found.

object

error

object

code

number

Example

404

title

string

Example

Not Found