List surveys
list_surveysRetrieve surveys from a SmartSurvey account with title, status, response count, and dates. Control pagination, sorting, and redaction of contact details.
Instructions
Surveys on this account with title, nickname, status (open or closed), response count and dates, in the order the API returns them. Whole API pages of min(100, max_results) surveys are returned, so the count may be below max_results; the note says how to continue. Emails and phone numbers in titles are redacted unless include_contact_details is set.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 1-based page to start from (for continuing a previous call) | |
| sort_by | No | Properties to sort by, passed through as the documented sort_by parameter (the accepted property names are not documented; the API's default order is used when omitted) | |
| max_results | No | Maximum number of surveys to return; also sets the API page size (up to 100) | |
| include_contact_details | No | Stop redacting email addresses and phone numbers in survey titles and nicknames |