All docs
IntegrationsUpdated

API reference

The REST endpoints for reading forms and submissions and creating a submission, how authentication works today, and how responses are shaped.

Key points
  • Formiqa exposes a small REST API under the base URL https://formiqa.app, returning JSON.
  • Endpoints cover listing forms, reading one form, listing a form's submissions, and creating a submission.
  • You authenticate with a Bearer token in the Authorization header, using your current session token.
  • Dedicated API keys are not yet available, so the API is best suited to your own scripts and back-office use.

Formiqa exposes a small REST API for reading your forms and submissions and for creating submissions programmatically. Every endpoint lives under the base URL https://formiqa.app and both requests and responses use JSON.

Authentication

You authenticate by sending a Bearer token in the Authorization header — that is, a header of the form Authorization: Bearer <token>. Today the token is your current session token, the same session that authenticates you in the app.

Endpoints

GET /api/v1/forms

Lists the forms on your account. Returns a JSON array of your forms with their basic metadata.

GET /api/v1/forms/{formId}

Fetches a single form by its identifier, including its configuration. Returns the form as a JSON object.

GET /api/v1/forms/{formId}/submissions

Lists the submissions for one form. This endpoint is paginated, so walk through the pages to retrieve the full history rather than expecting every submission in a single response.

POST /api/v1/forms/{formId}/submissions

Creates a submission for a form, exactly as if it had been filled in the browser. It validates required fields and checks your plan quota before accepting the response, so a call can be rejected if a required answer is missing or you have hit your submission limit.

Responses

All responses are JSON. A successful read returns the requested resource; a successful POST returns the created submission. When a request cannot be fulfilled — a missing required field, or a plan quota that has been reached — the API responds with an error status and a JSON body describing what went wrong, so you can surface it or retry appropriately.

Frequently asked questions

Do you have API keys?
Not yet. There is no dedicated API-key or key-management UI at the moment. You authenticate with your current session token, which makes the API best suited to your own scripts and back-office use rather than credentials shared with third parties.
How do I authenticate a request?
Send an Authorization header of the form "Authorization: Bearer <token>", where the token is your current session token. Responses come back as JSON.
Can I create submissions via the API?
Yes. POST to /api/v1/forms/{formId}/submissions. It validates required fields and your plan quota, so the call is rejected if a required answer is missing or you have reached your submission limit.
Is the submissions list paginated?
Yes. GET /api/v1/forms/{formId}/submissions is paginated, so page through the results to retrieve a form's full submission history.

Build a better form with Formiqa.

Free forever. No credit card. No per-response fees.