Tours

List tour feedback

Returns post-tour feedback surveys for the company, newest first.

A survey is created when a tour showing is approved on a board with tour feedback enabled, and the applicant answers it through an emailed link.

Accepts an API key (x-token), delegate token (Authorization: DelegateToken <token> with the tours scope), or partner token (Authorization: Bearer <token> with boards permission). When using a partner token, pass companyId as a query parameter.

get/api/tours/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/feedback/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

companyIdstring

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

instanceIdstring

Only surveys for this location/unit card.

status'completed' | 'pending' | 'all'

Whether to return answered surveys, surveys still awaiting an answer, or both.

startDatestring date-time

Only surveys completed on or after this ISO date.

endDatestring date-time

Only surveys completed on or before this ISO date.

limitinteger

Page size. Values above 200 are clamped.

offsetinteger

Response

A page of tour feedback.

totalinteger

Total matching surveys, ignoring limit/offset.