View as Markdown
Survicate icon

Survicate ACTION

List Responses

Fetches the list of responses for a specific survey identified by its unique ID. 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 List Responses 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-list-responses",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    survicate: { authProvisionId: "apn_xxxxxxx" },
    surveyId: "Survey",
    itemsPerPage: 10,
  },
})

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.

List Responses inputs
Property Type Description
surveyId Survey string
The ID of the survey
Required Dynamic
itemsPerPage Items Per Page integer
The number of items to display per page in the response. The minimum value is 1, and the maximum is 100.
Optional
start Start string
Optional start timestamp for filtering responses. Responses collected before this timestamp will be included. Format: ISO 8601 with microseconds (e.g., 2023-01-01T00:00:00.000000Z).
Optional
end End string
Optional end timestamp for filtering responses. Responses collected after this time will be included. Format: ISO 8601 with microseconds (e.g., 2023-01-01T00:00:00.000000Z).
Optional

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-list-responses
Version
0.0.1
App
Survicate
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes