# List Forms — Form.io

> List forms and resources in the Form.io project. Optionally filter by type to return only forms or only resources. Form.io returns up to limit records (default 10); if you receive a full page there may be more — raise limit (up to 1000) or…

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

## Description

List forms and resources in the Form.io project. Optionally filter by `type` to return only forms or only resources. Form.io returns up to `limit` records (default 10); if you receive a full page there may be more — raise `limit` (up to 1000) or page with `skip` to retrieve them all. Forms are large; pass `fields` to return only the fields you need (e.g. `_id`, `title`, `name`, `path`). [See the documentation](https://apidocs.form.io/#40baaaa1-c309-4f81-a546-6821cec14701).

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `type` | `string` | No | Filter by form type. One of form or resource. Omit to return both. |
| `limit` | `integer` | No | Maximum number of records to return. Min 1, max 1000. |
| `skip` | `integer` | No | Number of records to skip (for pagination). |
| `sort` | `string` | No | Field name to sort by; prefix with - for descending (e.g. -created, title). |
| `fields` | `string[]` | No | Optional. Return only these top-level fields from each form (e.g. _id, title, name, path, type). Omit to return the full form objects, which include the large components and access arrays. |

## 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": "form_io",
      },
    },
  },
)

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: "form_io-list-forms",
  arguments: {
    type: "Type",
    limit: 10,
  },
})
```

**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: "form_io-list-forms",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    form_io: { authProvisionId: "apn_xxxxxxx" },
    type: "Type",
    limit: 10,
  },
})

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": "form_io-list-forms",
    "configured_props": {
      "form_io": { "authProvisionId": "apn_xxxxxxx" },
      "type": "Type",
      "limit": 10
    }
  }'
```

---

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