feedbackResponses

List feedback responses

Changed on

Returns patient responses to NPS feedback surveys, along with clicks on the positive/negative feedback links sent after an appointment.

Read-only: feedback responses are recorded by the NPS survey / feedback-link flow, not created or edited through the API.

response.type is one of:

  • npsscore: the patient submitted a numeric NPS score (response.value is the score, also copied to npsscore for convenience).
  • positive-click / negative-click: the patient clicked the positive or negative link sent in the feedback message, before any score was collected.
get/feedbackResponses

Request

Query parameters

patientstring

The ID of patient

providerstring

The ID of provider

facilitystring

The ID of facility

appointmentstring

The ID of appointment

response.type'npsscore' | 'positive-click' | 'negative-click'
userstring

The ID of the root account user.

deleted0 | 1

Flag for logical deletion where 1 means deleted.

createdBystring

The ID of the user who created this object.

updatedBystring

The ID of the user who updated this object.

createdAtstring date-time

The date/time when this object was created.

updatedAtstring date-time

The date/time when this object was updated.

pageinteger
limitinteger

How many items to fetch per page

_populatestring

Response properties which will be replaced by the referenced objects, separated by commas.

_selectstring

Response properties that should be returned, separated by commas.

Response

A list of feedback responses

pageinteger
sizeinteger

Changes