View as Markdown
Form.io icon

Form.io ACTION

List Submissions

List submissions for a Form.io form. Optionally filter by state. Use List Forms to find the form ID. 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. Pass fields to return only the fields you need (e.g. _id, data, created). See the documentation.
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Form.io account once, then configure and run List Submissions 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: "form_io-list-submissions",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    form_io: { authProvisionId: "apn_xxxxxxx" },
    formId: "Form ID",
    state: "State",
  },
})

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 Submissions inputs
Property Type Description
formId Form ID string
The _id of the form. Run List Forms first to obtain valid form IDs.
Required
state State string
Filter by submission state. One of submitted or draft.
Optional
sort Sort string
Field name to sort by; prefix with - for descending (e.g. -created, title).
Optional
limit Limit integer
Maximum number of records to return. Min 1, max 1000.
Optional
skip Skip integer
Number of records to skip (for pagination).
Optional
fields Fields string[]
Optional. Return only these top-level fields from each submission (e.g. _id, data, created, state). Omit to return the full submission objects, which include access and metadata envelopes.
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
form_io-list-submissions
Version
0.0.1
App
Form.io
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes