Submissions API
ProAvailable on the Pro plan — coming soon
Besides the public submission endpoint (POST /api/v1/submit), Farvane will offer a read-only API to query your forms and submissions programmatically: sync them to a CRM, dump them into a spreadsheet, or build your own dashboard on top of them. The contract below is already fixed so it won't change once it ships — you can design your integration against this reference today.
Base URL
https://api.farvane.com/v1 — a different prefix from the public submit endpoint (api.farvane.com/api/v1/submit, no /v1, no authentication). The v1 prefix with no /api clearly marks this as the authenticated read API.
Authentication
Every request must include your personal key in the Authorization: Bearer frv_live_<your_key> header. The key will be generated from Account → API Keys in the dashboard once this feature ships.
Authorization: Bearer frv_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxEndpoints
| Method | Path | What it does |
|---|---|---|
GET | /v1/forms | Lists your account's forms, with each one's total submission count (total_count). |
GET | /v1/submissions?form_id=&limit=&cursor= | Lists submissions, paginated by cursor (has_more, next_cursor) instead of page number — avoids duplicates or gaps if new submissions arrive between pages. |
GET | /v1/submissions/{id} | A single submission by id. |
Errors
Every error shares the same envelope:
{"error":{"code":"not_found","message":"Submission not found"}}| Code | code | When it happens |
|---|---|---|
400 | bad_request | Invalid parameters (e.g. a malformed cursor). |
401 | unauthorized | The key is missing or invalid. |
403 | forbidden | The key is valid but doesn't have access to that resource. |
404 | not_found | The form or submission doesn't exist. |
429 | rate_limit_exceeded | Too many requests for this key. |
500 | server_error | Internal error. |
In the meantime
Every form can send you submissions as they arrive via a webhook, and each form inbox exports to CSV from the dashboard — no need to wait for this API.