List collectors with the SurveyMonkey API
Lists the collectors of a survey, the ways it receives responses, like a web link or an email invitation, with id and name; include adds type, status, url and response_count. Paginate with page while the response has links.next.
- Identifier
- surveymonkey_list_collectors
The request
POST https://connect.reportei.com/api/tools/surveymonkey_list_collectors/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"survey_id": "<survey_id>"
}
}Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| survey_id | string | Yes | Id of the survey, from List surveys. |
| name | string | No | Only the collectors whose name matches this text. |
| start_date | string | No | Only collectors created after this moment, a UTC date and time as YYYY-MM-DDTHH:MM:SS, without offset. |
| end_date | string | No | Only collectors created before this moment, a UTC date and time as YYYY-MM-DDTHH:MM:SS, without offset. |
| include | string | No | Extra fields, separated by commas: type, status, response_count, date_created, date_modified and url. |
| sort_by | string | No | Field the collectors are sorted by.Values: id, date_modified, type, status, name |
| sort_order | string | No | Ascending or descending order.Values: ASC, DESC |
| page | integer | No | Page of results, starting at 1. |
| per_page | integer | No | Results per page, up to 1000. |
Supported connections
Your customer connects their SurveyMonkey account once, with one of the modes below. The same connection serves every tool of the toolkit.
OAuth with your product's app
You register your product's OAuth app once, with POST /api/merchants/credentials/surveymonkey, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.
The response
On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.
Ready for AI agents
This tool's input is a JSON Schema, available at GET /api/tools/surveymonkey_list_collectors. It becomes your agent's tool definition with no conversion.
Other SurveyMonkey tools
- List surveysGETLists the surveys the account owns or that were shared with it, with id, title and nickname; include adds counts, dates and links. Paginate with page while the response has links.next.
- List survey foldersGETLists the survey folders of the account with id, title and number of surveys. Paginate with page while the response has links.next.
- Get surveyGETReturns the whole survey: settings, the edit, preview, collect and analyze links, and every page with its questions and answer choices, all with their ids. The response tools and List survey rollups refer to these ids.
- Create surveyPOSTCreates a survey: empty, copied from another survey with from_survey_id, or with its pages and questions in pages. Returns the survey id and its edit, preview and collect links. It still needs a collector to receive responses.
- Update surveyPATCHChanges the title, nickname, language, button texts, custom variables, footer or folder of a survey. Pages and questions stay as they are.
- Create collectorPOSTCreates a collector for a survey. A weblink collector returns the link to share in url, and it is the only type the free plan can create. An email collector only sets the invitation up: recipients and sending stay in SurveyMonkey.
- Update collectorPATCHChanges a collector: closes it or opens it again with status, or changes its name, close date, response limit, messages and redirect.
- List responsesGETLists the responses of a survey with all answers, as question, choice and row ids, plus the texts when simple is true. On the free plan only the first 25 responses of each survey come back, and more returns error 1005. Paginate with page while the response has links.next.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
