---
title: "List tour feedback"
method: GET
path: "/api/tours/feedback"
tags: ["Tours"]
---

# List tour feedback

`GET /api/tours/feedback`

## Request

- Base URL: `https://core-api.getaptly.com`
- URL: `https://core-api.getaptly.com/api/tours/feedback`
- Auth: one of:
  - API key in header `x-token`
  - API key in header `Authorization`
  - 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)

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.

## Query parameters

- `companyId` string
- `instanceId` string
- `status` 'completed' | 'pending' | 'all'
- `startDate` string, date-time
- `endDate` string, date-time
- `limit` integer
- `offset` integer

## Response `200`

A page of tour feedback.

- object
  - `data` TourFeedback[]
    - `showingId` string: Showing (portal application) ID.
    - `status` 'completed' | 'pending': `completed` once the applicant answered; `pending` while the survey is still out.
    - `sentAt` string, date-time, nullable: When the survey was emailed to the applicant.
    - `completedAt` string, date-time, nullable: When the applicant submitted their answers.
    - `tourDate` string, date-time, nullable
    - `instanceId` string, nullable: The location/unit card the tour was for.
    - `propertyName` string, nullable: Name of that location card.
    - `applicant` object
      - `firstName` string, nullable
      - `lastName` string, nullable
      - `email` string, nullable
    - `responses` object[]
      - `question` string, nullable: The question text as it was shown to the applicant.
      - `answer` string, nullable: The raw answer. Rating questions answer "1"-"5"; text questions answer free text.
      - `rating` integer, nullable: The answer as a number when it is a 1-5 rating, otherwise null.
    - `averageRating` number, nullable: Mean of this survey's numeric ratings, or null when nothing was rated.
  - `total` integer: Total matching surveys, ignoring limit/offset.
  - `limit` integer
  - `offset` integer

## Other responses

- `400`: Missing companyId, or an invalid status, date, limit or offset.
- `401`: Invalid or missing credential.

---

[API](https://skmtc.dev/getaptly/apis/aptly-api.md) - [All operations](https://skmtc.dev/getaptly/apis/aptly-api/llms.txt) - [OpenAPI document](https://skmtc.dev/getaptly/apis/aptly-api/revisions/75c367e0b8e5?raw)