> Markdown versions of all pages of this connector library are available by appending `.md` to the page URL. For the full index of connectors, see [llms.txt](https://connectors.appmixer.com/llms.txt).

# Get Survey

- Component: `appmixer.surveymonkey.core.GetSurvey`
- Kind: Action
- Version: 1.0.0
- Visibility: Public
- Connector: [appmixer.surveymonkey 1.0.0](https://connectors.appmixer.com/connector/appmixer.surveymonkey/1.0.0.md)
- Component page: <https://connectors.appmixer.com/connector/appmixer.surveymonkey/1.0.0/component/appmixer.surveymonkey.core.GetSurvey>

Get a survey with its pages and questions.

## Input ports

### Port `in`

| Field | Type | Description |
| --- | --- | --- |
| Survey (`surveyId`) | text | Pick a survey, or type its Survey ID. |

## Output ports

### Port `out`

| Field | Type | Description |
| --- | --- | --- |
| Survey ID (`id`) | string | - |
| Title (`title`) | string | - |
| Nickname (`nickname`) | string | - |
| Language (`language`) | string | - |
| Category (`category`) | string | - |
| Question Count (`question_count`) | integer | - |
| Page Count (`page_count`) | integer | - |
| Response Count (`response_count`) | integer | - |
| Date Created (`date_created`) | string | - |
| Date Modified (`date_modified`) | string | - |
| Folder ID (`folder_id`) | string | - |
| Footer (`footer`) | boolean | - |
| Custom Variables (`custom_variables`) | object | - |
| Buttons Text (`buttons_text`) | object | - |
| Preview URL (`preview`) | string | - |
| Edit URL (`edit_url`) | string | - |
| Collect URL (`collect_url`) | string | - |
| Analyze URL (`analyze_url`) | string | - |
| Summary URL (`summary_url`) | string | - |
| API URL (`href`) | string | - |
| Pages (`pages`) | array | - |

## Full metadata (component.json)

```json
{
  "name": "appmixer.surveymonkey.core.GetSurvey",
  "label": "Get Survey",
  "description": "Get a survey with its pages and questions.",
  "author": "Appmixer <info@appmixer.com>",
  "version": "1.0.0",
  "auth": {
    "service": "appmixer:surveymonkey"
  },
  "quota": {
    "manager": "appmixer:surveymonkey",
    "resources": "requests",
    "scope": {
      "userId": "{{userId}}"
    }
  },
  "inPorts": [
    {
      "name": "in",
      "schema": {
        "type": "object",
        "properties": {
          "surveyId": {
            "type": "string"
          }
        },
        "required": [
          "surveyId"
        ]
      },
      "inspector": {
        "inputs": {
          "surveyId": {
            "type": "text",
            "index": 1,
            "label": "Survey",
            "tooltip": "Pick a survey, or type its Survey ID.",
            "source": {
              "url": "/component/appmixer/surveymonkey/core/ListSurveys?outPort=out",
              "data": {
                "properties": {
                  "isSource": true
                },
                "transform": "./ListSurveys#toSelectArray"
              }
            }
          }
        }
      }
    }
  ],
  "outPorts": [
    {
      "name": "out",
      "schema": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "title": "Survey ID",
            "example": "405123456"
          },
          "title": {
            "type": "string",
            "title": "Title",
            "example": "Customer Satisfaction 2026"
          },
          "nickname": {
            "type": "string",
            "title": "Nickname",
            "example": "CSAT Q1"
          },
          "language": {
            "type": "string",
            "title": "Language",
            "example": "en"
          },
          "category": {
            "type": "string",
            "title": "Category",
            "example": "customer_feedback"
          },
          "question_count": {
            "type": "integer",
            "title": "Question Count",
            "example": 10
          },
          "page_count": {
            "type": "integer",
            "title": "Page Count",
            "example": 2
          },
          "response_count": {
            "type": "integer",
            "title": "Response Count",
            "example": 12
          },
          "date_created": {
            "type": "string",
            "title": "Date Created",
            "example": "2026-03-05T14:30:00"
          },
          "date_modified": {
            "type": "string",
            "title": "Date Modified",
            "example": "2026-03-06T09:12:00"
          },
          "folder_id": {
            "type": "string",
            "title": "Folder ID",
            "example": "1234"
          },
          "footer": {
            "type": "boolean",
            "title": "Footer",
            "example": true
          },
          "custom_variables": {
            "type": "object",
            "title": "Custom Variables",
            "example": {
              "name": "label"
            },
            "properties": {}
          },
          "buttons_text": {
            "type": "object",
            "title": "Buttons Text",
            "properties": {
              "done_button": {
                "type": "string",
                "title": "Buttons Text.Done Button",
                "example": "Done"
              },
              "prev_button": {
                "type": "string",
                "title": "Buttons Text.Previous Button",
                "example": "Prev"
              },
              "exit_button": {
                "type": "string",
                "title": "Buttons Text.Exit Button",
                "example": "Exit"
              },
              "next_button": {
                "type": "string",
                "title": "Buttons Text.Next Button",
                "example": "Next"
              }
            }
          },
          "preview": {
            "type": "string",
            "title": "Preview URL",
            "example": "https://www.surveymonkey.com/r/Preview/?sm=abc123"
          },
          "edit_url": {
            "type": "string",
            "title": "Edit URL",
            "example": "https://www.surveymonkey.com/create/?sm=abc123"
          },
          "collect_url": {
            "type": "string",
            "title": "Collect URL",
            "example": "https://www.surveymonkey.com/collect/list?sm=abc123"
          },
          "analyze_url": {
            "type": "string",
            "title": "Analyze URL",
            "example": "https://www.surveymonkey.com/analyze/abc123"
          },
          "summary_url": {
            "type": "string",
            "title": "Summary URL",
            "example": "https://www.surveymonkey.com/summary/abc123"
          },
          "href": {
            "type": "string",
            "title": "API URL",
            "example": "https://api.surveymonkey.com/v3/surveys/405123456"
          },
          "pages": {
            "type": "array",
            "title": "Pages",
            "example": [
              {
                "id": "987654",
                "title": "Page 1",
                "description": "",
                "position": 1,
                "question_count": 1,
                "questions": [
                  {
                    "id": "123456789",
                    "position": 1,
                    "family": "open_ended",
                    "subtype": "single",
                    "headings": [
                      {
                        "heading": "How likely are you to recommend us?"
                      }
                    ]
                  }
                ]
              }
            ],
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "title": "Pages.Page ID",
                  "example": "987654"
                },
                "title": {
                  "type": "string",
                  "title": "Pages.Title",
                  "example": "Page 1"
                },
                "description": {
                  "type": "string",
                  "title": "Pages.Description",
                  "example": "About you"
                },
                "position": {
                  "type": "integer",
                  "title": "Pages.Position",
                  "example": 1
                },
                "question_count": {
                  "type": "integer",
                  "title": "Pages.Question Count",
                  "example": 1
                },
                "href": {
                  "type": "string",
                  "title": "Pages.API URL",
                  "example": "https://api.surveymonkey.com/v3/surveys/405123456/pages/987654"
                },
                "questions": {
                  "type": "array",
                  "title": "Pages.Questions",
                  "example": [
                    {
                      "id": "123456789",
                      "position": 1,
                      "family": "open_ended",
                      "subtype": "single"
                    }
                  ],
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string",
                        "title": "Pages.Questions.Question ID",
                        "example": "123456789"
                      },
                      "position": {
                        "type": "integer",
                        "title": "Pages.Questions.Position",
                        "example": 1
                      },
                      "family": {
                        "type": "string",
                        "title": "Pages.Questions.Family",
                        "example": "open_ended"
                      },
                      "subtype": {
                        "type": "string",
                        "title": "Pages.Questions.Subtype",
                        "example": "single"
                      },
                      "visible": {
                        "type": "boolean",
                        "title": "Pages.Questions.Visible",
                        "example": true
                      },
                      "href": {
                        "type": "string",
                        "title": "Pages.Questions.API URL",
                        "example": "https://api.surveymonkey.com/v3/surveys/405123456/pages/987654/questions/123456789"
                      },
                      "headings": {
                        "type": "array",
                        "title": "Pages.Questions.Headings",
                        "example": [
                          {
                            "heading": "How likely are you to recommend us?"
                          }
                        ],
                        "items": {
                          "type": "object",
                          "properties": {
                            "heading": {
                              "type": "string",
                              "title": "Pages.Questions.Headings.Heading",
                              "example": "How likely are you to recommend us?"
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  ],
  "icon": "(data URI omitted)"
}
```
