View as Markdown
Survicate icon

Survicate ACTION

List Surveys

Retrieves a list of all surveys from your workspace. 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 Surveys 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-surveys",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    survicate: { authProvisionId: "apn_xxxxxxx" },
    itemsPerPage: 10,
    start: "Start",
  },
})

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 Surveys inputs
Property Type Description
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
The start timestamp to filter surveys by their creation date. Surveys are ordered from latest to oldest. Thus, surveys created before or at this timestamp will be included in the response. The timestamp should be in the ISO 8601 format, including microseconds (e.g., 2023-01-01T00:00:00.000000Z).
Optional
end End string
The end timestamp to filter surveys by their creation date. Surveys are ordered from latest to oldest. Thus, surveys created on or after this timestamp will be included in the response. The timestamp should be in the ISO 8601 format, including 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-surveys
Version
0.0.1
App
Survicate
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes