Skip to content

API reference

Submissions

Read the submissions of your workspace, newest first, and page back through them. Test submissions from the form builder are left out.

List submissions

GEThttps://switchyard-ccn.modulify.website/api/v1/submissions

Query

formstring
Only submissions of this form id.
statusstring
One of received, delivered, failed, invalid or spam.
sinceISO date
Only submissions received at or after this time.
beforeISO date
Only submissions received before this time. Use next_before from the last answer to get the next page.
limitnumber
1 to 100. 50 when left out.
cURL
curl "https://switchyard-ccn.modulify.website/api/v1/submissions?form=frm_q8w2e4r6t1y3&limit=20" \
  -H "Authorization: Bearer $FORMERA_API_KEY"
200 OK
{
  "data": [
    {
      "id": "sub_7k2m9x4q1w3e5r6t",
      "form_id": "frm_q8w2e4r6t1y3",
      "source_id": "src_m3n5b7v9c1x2",
      "status": "delivered",
      "received_at": "2026-11-20T09:30:00.000Z",
      "data": {
        "email": "jane@example.com",
        "topic": "sales",
        "interests": ["speed", "support"]
      }
    }
  ],
  "next_before": "2026-11-20T09:30:00.000Z"
}

next_before is null when there are no more submissions. Answers in data are exactly what was sent: option values rather than labels, and numbers as text.

Read every page

JavaScript
let before = null
const all = []

do {
  const url = new URL("https://switchyard-ccn.modulify.website/api/v1/submissions")
  url.searchParams.set("limit", "100")
  if (before) url.searchParams.set("before", before)

  const response = await fetch(url, { headers: { Authorization: `Bearer ${process.env.FORMERA_API_KEY}` } })
  const page = await response.json()

  all.push(...page.data)
  before = page.next_before
} while (before)

Read one submission

GEThttps://switchyard-ccn.modulify.website/api/v1/submissions/{id}

Adds the page it was sent from, the country, the files and every flow run with its steps.

200 OK
{
  "data": {
    "id": "sub_7k2m9x4q1w3e5r6t",
    "form_id": "frm_q8w2e4r6t1y3",
    "source_id": "src_m3n5b7v9c1x2",
    "status": "delivered",
    "received_at": "2026-11-20T09:30:00.000Z",
    "data": { "email": "jane@example.com", "topic": "sales", "brief": "brief.pdf" },
    "meta": {
      "page_url": "https://yourcompany.com/contact",
      "country": "DE",
      "user_agent": "Mozilla/5.0 ..."
    },
    "files": [
      { "id": "fil_4r6t8y0u2i4o", "field": "brief", "filename": "brief.pdf", "size": 182044, "content_type": "application/pdf" }
    ],
    "runs": [
      {
        "id": "run_2w4e6r8t0y2u",
        "flow_id": "flw_9o7i5u3y1t2r",
        "flow_name": "Route new leads",
        "status": "completed",
        "outcome": "delivered",
        "started_at": "2026-11-20T09:30:01.120Z",
        "steps": [
          { "kind": "trigger", "label": "Form submitted", "status": "success", "summary": "Received a submission for \"Contact\"", "at": "2026-11-20T09:30:01.124Z" },
          { "kind": "ai", "label": "Ask AI", "status": "success", "summary": "AI answered \"Sales\"", "at": "2026-11-20T09:30:02.010Z" },
          { "kind": "slack", "label": "Post to Slack", "status": "success", "summary": "Posted to #sales-leads", "at": "2026-11-20T09:30:02.420Z" }
        ]
      }
    ]
  }
}

File contents are not part of the API. Open them from the submission in your inbox, where each one opens through a private link.

Made with Modulify