# List Surveys — Survicate

> Retrieves a list of all surveys from your workspace. See the documentation

- Key: `survicate-list-surveys`
- Type: Action (Read-only)
- Version: 0.0.1
- App: Survicate (`survicate`) — https://pipedream.com/apps/survicate.md
- This page (HTML): https://pipedream.com/apps/survicate/actions/list-surveys
- Hints: read-only · open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/survicate/actions/list-surveys/list-surveys.mjs

## Description

Retrieves a list of all surveys from your workspace. [See the documentation](https://developers.survicate.com/data-export/survey/)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `itemsPerPage` | `integer` | No | The number of items to display per page in the response. The minimum value is 1, and the maximum is 100. |
| `start` | `string` | No | 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). |
| `end` | `string` | No | 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). |

## Run it

**MCP**

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
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 accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_PROJECT_ID!,
        "x-pd-environment": "production",
        "x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
        "x-pd-app-slug": "survicate",
      },
    },
  },
)

const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)

const { tools } = await mcp.listTools()

// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
  name: "survicate-list-surveys",
  arguments: {
    itemsPerPage: 10,
    start: "Start",
  },
})
```

**TypeScript**

```ts
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)
```

**cURL**

```bash
curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
  -H "Content-Type: application/json" \
  -H "X-PD-Environment: production" \
  -H "Authorization: Bearer {access_token}" \
  -d '{
    "external_user_id": "{external_user_id}",
    "id": "survicate-list-surveys",
    "configured_props": {
      "survicate": { "authProvisionId": "apn_xxxxxxx" },
      "itemsPerPage": 10,
      "start": "Start"
    }
  }'
```

---

- App: https://pipedream.com/apps/survicate.md · All apps: https://pipedream.com/apps