View as Markdown
Surveybot icon

Surveybot ACTION

Get Survey Respondent

Get a respondent for a survey from SurveyBot. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Surveybot account once, then configure and run Get Survey Respondent from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "surveybot-get-survey-respondent",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    surveybot: { authProvisionId: "apn_xxxxxxx" },
    surveyId: "Survey ID",
    respondentId: "Respondent ID",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Get Survey Respondent inputs
Property Type Description
surveyId Survey ID string
The ID of the survey to get responses for
Required Dynamic
respondentId Respondent ID string
The ID of the respondent to get
Required Dynamic

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
surveybot-get-survey-respondent
Version
0.0.1
App
Surveybot
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes