---
title: "Get entity from Survey by key"
method: GET
path: "/Survey({Id})"
tags: ["Survey"]
---

# Get entity from Survey by key

`GET /Survey({Id})`

## Path parameters

- `Id` number, nullable, required

## Query parameters

- `$select` string[]
- `$expand` string[]

## Response `200`

Retrieved entity

- ChurnZeroSurvey — A campaign that collects customer feedback. Supports NPS (loyalty 0-10), CSAT (satisfaction), CES (effort), and Custom multi-question formats. Targets either Contacts (responses roll up to the Account) or Custom Table records. Send modes are Periodic (recurring on a schedule) or Segment Entry (sends when a Contact/record enters a chosen Segment).
  - `Id` number — Internal identifier for ChurnZero.
  - `CampaignStatus` string — The lifecycle status of the survey: Draft, Paused, Running, Complete, or Archived. Running surveys are actively sending (shown as Active in the ChurnZero UI).
  - `CampaignType` string — How the survey dispatches: Periodic (recurring on a schedule), OnSegmentEntry (sends when a Contact or record enters a targeted Segment), External (responses collected outside ChurnZero and synced in), or Imported (historical responses imported from another platform).
  - `DripOverMonths` number — The drip rate for a Periodic survey: the number of months (1, 3, or 6) the send is spread over, surveying a portion of the target population each day instead of sending to everyone at once. 0 means the survey sends to everyone at once.
  - `FollowUpQuestions` ChurnZeroFollowUpQuestion[] — The follow-up questions asked after the recipient submits their score. Each has the question text and an AnswerType: Text, YesNo, Currency, Date, Number, Percent, SingleSelect, or MultiSelect.
    - `Question` string, nullable — The text of the question.
    - `AnswerType` string, nullable — The type of answer associated with the question.
  - `IsActive` boolean — Whether the survey is actively processing recipients. When set to false the survey pauses in place: no new recipients enter and no further sends or reminders go out until it is reactivated.
  - `Name` string — The name of the survey, shown on the Surveys page in ChurnZero.
  - `RecurringEveryMonths` number — For Periodic surveys, the recurrence interval in months: how long after a recipient's previous survey they are surveyed again (e.g. 6 = re-surveyed six months later). 0 means a one-time survey.
  - `SegmentIds` number[] — The Ids of the Segments that define the survey's audience. Membership in any one of the listed Segments qualifies a recipient (OR logic).
  - `Settings` object, nullable — Additional settings on a survey.
    - `ChoiceCount` number, nullable — The number of choices available to answer a survey.
    - `AnswerType` string, nullable — The type of answer associated with the question.
  - `SurveyQuestion` string — The text of the survey's primary question shown to recipients (e.g. the NPS question "How likely is it that you would recommend ... ?").
  - `SurveyType` string — The type of the survey: NPS (loyalty, scored 0-10), CSAT (satisfaction), CES (effort, 1-7 scale), or Custom (multi-question survey; see the SurveyQuestion entity for its questions).

## Other responses

- `400` — Bad Request|This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again.
- `401` — Unauthorized|A valid authentication token was not provided with the request, so the API could not associate a user with the request.
- `403` — Forbidden|The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to.
- `404` — Not Found|Either the request method and path supplied do not specify a known action in the API, or the object specified by the request does not exist.
- `409` — Conflict|The underlying model/schema has changed. Usually caused by a race condition. Sending the request again will succeed.
- `429` — Too Many Requests|You have exceeded one of the enforced rate limits in the API. See the documentation on rate limiting for more information.
- `500` — Internal Server Error|There was a problem on ChurnZeros's end.
- `default` — error

---

[API](https://skmtc.net/churnzero/apis/churnzero-rest-api-for-marketingpony.md) · [All operations](https://skmtc.net/churnzero/apis/churnzero-rest-api-for-marketingpony/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/churnzero/churnzero-rest-api-for-marketingpony/revisions/fa74265a328d/schema)