Skip to content
Upvio Developer Docs

List Form Submissions

GET
/businesses/{businessId}/form-submissions

List all forms

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
businessId
required

The ID of the Business.

string

Query Parameters

Section titled “Query Parameters ”
limit

The maximum number of Form Submissions to return.

integer
default: 10 <= 50
offset

The number of Form Submissions to skip before starting to collect the result set.

integer
0 <= 10000
filters

Filter options for Form Submissions.

object
formId

Filter by Form ID.

string
patientId

Filter by Patient ID.

string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

List of Form Submissions

object
data
Array<object>
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