Surveys
Search Surveys
Search and list Survey records with filtering, sorting, and pagination.
GET
Search Surveys
A survey (Survey) is a location-specific questionnaire sent to selected customers on a recurring schedule. It defines delivery timing, customer eligibility, and the questions customers can answer.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the Survey-List role.Enums
eSurveyDeliveryFrequency — DeliveryFrequency values
eSurveyDeliveryFrequency — DeliveryFrequency values
Query Parameters
Pagination & Sorting
Filters
Filter by iD of the location that owns this survey; the Admin Tool normally supplies it from the current location context.
Filter by whether this survey is eligible for scheduled delivery when its next delivery date is due.
Filter by uTC date and time when the next scheduled delivery is due; the system advances it by the delivery rate after a delivery.
Filter by positive number of delivery-frequency units between scheduled deliveries; a value of zero prevents scheduled delivery.
Filter by unit used by DeliveryRate and the delivery cap: Weeks, Months, or Years; defaults to Weeks.
Filter by maximum number of DeliveryFrequency units after StartDate for scheduled deliveries; zero means no end date.
Filter by legacy delivery-cap frequency setting; the delivery-cap calculation uses DeliveryFrequency, so manage the cap with DeliveryRateMaximum and DeliveryFrequency instead.
Filter by optional UTC date and time from which the delivery cap is measured; without it, the delivery cap does not apply.
Filter by system-managed scheduler job ID while a delivery is queued; it is cleared after delivery and must never be set by an agent.
Filter by whether delivery is restricted to contacts without an active contract; when enabled with OnlyForMembers, both restrictions apply and no customer can qualify.
Filter by whether delivery is restricted to members with an active contract; when Tariffs is non-empty, the contract must be on one of those plans.
Range Filters
Filter by uTC date and time when the next scheduled delivery is due; the system advances it by the delivery rate after a delivery greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by uTC date and time when the next scheduled delivery is due; the system advances it by the delivery rate after a delivery less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by positive number of delivery-frequency units between scheduled deliveries; a value of zero prevents scheduled delivery greater than or equal to this value.
Filter by positive number of delivery-frequency units between scheduled deliveries; a value of zero prevents scheduled delivery less than or equal to this value.
Filter by maximum number of DeliveryFrequency units after StartDate for scheduled deliveries; zero means no end date greater than or equal to this value.
Filter by maximum number of DeliveryFrequency units after StartDate for scheduled deliveries; zero means no end date less than or equal to this value.
Filter by optional UTC date and time from which the delivery cap is measured; without it, the delivery cap does not apply greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by optional UTC date and time from which the delivery cap is measured; without it, the delivery cap does not apply less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Code Examples
Simple listing
Filtering by Name
Range filters
Response
200
The list of Survey records matching the query. See the Get one Survey endpoint for the full list of properties returned for each record.
Example Response