Skip to main content
GET
Get one showing's tour feedback

Authorizations

x-token
string
header
required

Path Parameters

showingId
string
required

Showing (portal application) ID.

Query Parameters

companyId
string

Company ID. Required when using a partner token; resolved automatically for API key and delegate token auth.

Response

The tour feedback survey.

One tour showing's post-tour feedback survey.

showingId
string

Showing (portal application) ID.

status
enum<string>

completed once the applicant answered; pending while the survey is still out.

Available options:
completed,
pending
sentAt
string<date-time> | null

When the survey was emailed to the applicant.

completedAt
string<date-time> | null

When the applicant submitted their answers.

tourDate
string<date-time> | null
instanceId
string | null

The location/unit card the tour was for.

propertyName
string | null

Name of that location card.

applicant
object
responses
object[]
averageRating
number | null

Mean of this survey's numeric ratings, or null when nothing was rated.