Tours

Get one showing's tour feedback

Returns the tour feedback survey for a single showing.

A showing that belongs to another company reads as not found.

get/api/tours/{showingId}/feedback

Request

Base URL
https://core-api.getaptly.com
Auth
- API key in header x-token
- or API key in header Authorization
- or HTTP bearer
TypeScript
https://skmtc.dev/getaptly/apis/aptly-api/docs/api/tours/:showingId/feedback/get.ts
A function with typed inputs. Its response is checked against the schema.

showingIdstring required

Showing (portal application) ID.

companyIdstring

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

The tour feedback survey.

showingIdstring

Showing (portal application) ID.

status'completed' | 'pending'

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

sentAtstring date-time nullable

When the survey was emailed to the applicant.

completedAtstring date-time nullable

When the applicant submitted their answers.

tourDatestring date-time nullable

instanceIdstring nullable

The location/unit card the tour was for.

propertyNamestring nullable

Name of that location card.

averageRatingnumber nullable

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

No recorded changes to this operation across all 1 revision of this API.