View as Markdown
Survicate icon

Survicate ACTION

Get Survey

Retrieves detailed information about a specific survey. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Survicate account once, then configure and run Get Survey 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: "survicate-get-survey",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    survicate: { authProvisionId: "apn_xxxxxxx" },
    surveyId: "Survey",
  },
})

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 inputs
Property Type Description
surveyId Survey string
The ID of the survey
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
survicate-get-survey
Version
0.0.1
App
Survicate
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes