Forms - osforms

These endpoints are what the dashboard uses. They require your login session: the ff_token cookie, or the same JWT sent as Authorization: Bearer <token>. See Auth.

To read submissions from your own server, use the Pull Submissions API with an API key instead. It’s read-only, scoped to the forms you choose, and doesn’t expire like a login session.

List forms

GET /api/v1/forms

Returns all your forms with submission counts, plus this month’s usage.

{
  "forms": [
    {
      "_id": "671fa2b3c4d5e6f7a8b9c0aa",
      "name": "Contact Form",
      "slug": "UNKMzY8jm18x",
      "active": true,
      "submissionCount": 42,
      "createdAt": "2026-09-01T10:00:00.000Z",
      "updatedAt": "2026-09-01T10:00:00.000Z"
    }
  ],
  "usage": {
    "submissionsUsed": 42,
    "submissionsLimit": 100,
    "currentMonth": "2026-10"
  }
}

Create a form

POST /api/v1/forms

{
  "name": "Contact Form"
}

Returns 201 with { "form": { ... } }. The form’s slug is generated for you and forms its endpoint: /api/v1/f/{slug}.

Get a form

GET /api/v1/forms/{id}

Returns { "form": { ..., "submissionCount", "integrationCount" }, "integrations": [...] }.

Update a form

PATCH /api/v1/forms/{id}

{
  "redirectUrl": "https://example.com/thanks",
  "allowedOrigins": ["https://example.com"],
  "rateLimit": 20
}

Field	Type	Description
`name`	string	Form name, 1 to 100 characters
`active`	boolean	Inactive forms reject submissions with `404`
`redirectUrl`	string	Where HTML form submissions are redirected after success
`allowedOrigins`	string[]	Origins allowed to submit. Empty means any origin
`honeypotField`	string	Name of the hidden honeypot input
`recaptchaSecret`	string	reCAPTCHA or hCaptcha secret key. Enables CAPTCHA checks on the endpoint
`rateLimit`	number	Submissions per minute per IP, 1 to 1000. Default `10`
`formSchema`	object	Form builder schema. `null` makes the form headless (accepts any fields)

rateLimit and recaptchaSecret can only be set through this endpoint for now. The dashboard’s Setup tab covers the other fields.

Delete a form

DELETE /api/v1/forms/{id}

Deletes the form with all its submissions and integrations. It also removes the form from any API key that could read it.

List submissions

GET /api/v1/forms/{id}/submissions?page=1&limit=25

limit defaults to 25, maximum 100. Newest first.

{
  "submissions": [
    {
      "_id": "6720b3f1c4d5e6f7a8b9c0d1",
      "formId": "671fa2b3c4d5e6f7a8b9c0aa",
      "data": { "name": "Jane", "email": "[email protected]" },
      "metadata": { "ip": "...", "userAgent": "...", "origin": "..." },
      "integrationStats": { "success": 2, "failed": 0 },
      "createdAt": "2026-10-02T09:14:03.120Z"
    }
  ],
  "pagination": { "page": 1, "limit": 25, "total": 42, "totalPages": 2 }
}

Integration logs for a submission

GET /api/v1/submissions/{id}/logs

Returns { "logs": [{ "status", "message", "createdAt", "integration": { "id", "name", "type" } }] }.

Submission stats

GET /api/v1/forms/{id}/stats/submissions?period=30d
GET /api/v1/stats/submissions?period=30d

Daily submission counts for one form, or across all your forms. period is 7d, 30d (default), or 90d.

{
  "chartData": [{ "date": "2026-10-01", "submissions": 3 }]
}

Export submissions

GET /api/v1/forms/{id}/export

Downloads every submission as CSV, with columns ID, Date, then one column per field. CSV is the only format.

​List forms

​Create a form

​Get a form

​Update a form

​Delete a form

​List submissions

​Integration logs for a submission

​Submission stats

​Export submissions

List forms

Create a form

Get a form

Update a form

Delete a form

List submissions

Integration logs for a submission

Submission stats

Export submissions