List Collectors
surveymonkey.list_collectors
ActionBusiness appsconnection required
Calls the SurveyMonkey API with the connection's credentials.
List the collectors on a survey — the weblink, email, SMS and popup ways it is being distributed.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- OAuth 2.0
- Providers
- SurveyMonkey
- Secret shape
- the OAuth2 access token, or {"access_token": "…"}
- Config it needs
- base_url, datacenter
- Resolved by
- config.connection_id, else node.connection_id
Configuration
9 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
survey_id The SurveyMonkey survey id, as shown in the survey's API href. | string | Yes | — | — | 309683094 |
page Which page of results to return; SurveyMonkey starts at page 1. | number | No | — | ≥ 1 | 1 |
per_page How many resources to return per page; SurveyMonkey caps a page at 1000. | number | No | — | 1–1000 | 50 |
sort_by The field the collector list is ordered by. | string | No | — | one of "id", "date_modified", "type", "status", "name" | — |
sort_order Whether the chosen sort runs ascending or descending. | string | No | — | one of "ASC", "DESC" | — |
name Return only the collectors whose name matches this search text. | string | No | — | — | — |
include Comma-separated extra fields per collector: type, status, response_count, date_created, date_modified or url. | string | No | — | — | type,status,url |
start_date Only collectors created at or after this timestamp. | string | No | — | iso8601 format | — |
end_date Only collectors created at or before this timestamp. | string | No | — | iso8601 format | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"include": "type,status,url",
"page": 1,
"per_page": 50,
"survey_id": "309683094"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
items The resources in this page, exactly as SurveyMonkey returned them. | array | — |
count How many resources this page actually contains. | number | — |
page The page number SurveyMonkey reported for this result. | number | — |
per_page The page size SurveyMonkey reported for this result. | number | — |
total How many resources match the query in total. | number | — |
next_page_url SurveyMonkey's URL for the next page, or an empty string. | string | — |
has_more True while SurveyMonkey still offers a next page. | boolean | — |
{
"count": 0,
"has_more": false,
"items": [],
"next_page_url": "",
"page": 0,
"per_page": 0,
"total": 0
}Notes
- SurveyMonkey pages with page/per_page and only sends links.next while more results exist.
See List Collectors run in a workflow.
In a technical demo we add the SurveyMonkey connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.