---
title: "Query cancel survey responses"
method: POST
path: "/subscriptions/cancelSurvey/response/query"
tags: ["Subscriptions"]
---

# Query cancel survey responses

`POST /subscriptions/cancelSurvey/response/query`

Returns a paginated list of cancel survey responses submitted within a specific date range.

Results can be filtered by `startDate`, `endDate`, and optionally by `productPath`.

Supports sorting by `creationTime` or `reasonId`, in ascending or descending order.

## Request body

- object
  - `startDate` string, date-time, required — Start of the query window (ISO 8601 format).
  - `endDate` string, date-time, required — End of the query window (ISO 8601 format).
  - `productPath` string — Optional filter to limit results to a specific product.
  - `pagination` object, required
    - `limit` integer, required — Max number of records to return per page.
    - `offset` integer, required — Number of records to skip before returning results.
  - `sorting` object
    - `field` 'creationTime' | 'reasonId' — Field to sort by. Options include: - `creationTime`: Time the survey was submitted - `reasonId`: Cancel reason ID
    - `order` 'asc' | 'desc' — Sort direction.

## Response `200`

OK

- object
  - `totalRecords` integer — Total number of matching cancel survey records.
  - `totalPages` integer — Number of pages based on totalRecords and page size.
  - `surveys` object[] — List of cancel survey responses.
    - `id` string — Unique ID of the cancel survey response.
    - `subscriptionId` string — ID of the subscription associated with the response.
    - `reasonId` string — ID of the cancel reason.
    - `name` string — Predefined name for the cancel reason.
    - `displayName` string — Label shown to the user.
    - `lang` string — Language code used for the survey.
    - `description` string — Long-form explanation of the cancel reason.
    - `feedbackText` string — Freeform feedback text submitted with the survey.
    - `site` string — ID of the site associated with the subscription.
    - `productPath` string — Product path of the canceled subscription.
    - `creationTime` string — Timestamp when the cancel survey response was created.

## Other responses

- `401` — Authentication credentials are missing or invalid.
- `429` — Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header.
- `500` — Internal server error.

---

[API](https://skmtc.net/fastspring/apis/fastspring-api-accounts.md) · [All operations](https://skmtc.net/fastspring/apis/fastspring-api-accounts/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/fastspring/fastspring-api-accounts/versions/ae2f0b97db3e/schema)