The API
The Management API lets your own scripts and servers do what the app does: read submissions, mark spam, publish forms and change what happens after Send.
GET
https://api.seaforms.io/v1/{resource}curl https://api.seaforms.io/v1/sites \ -H "Authorization: Bearer $SEAFORMS_API_KEY"{ "data": [ { "id": "site_01JC8H2K4M9V6Q3T7X0B5N2R8D", "name": "Northwind", "platform": "npm", "platformSiteId": null, "domains": ["https://northwind.co", "https://www.northwind.co"], "plan": { "plan": "pro", "source": "subscription" }, "createdAt": "2026-11-02T04:12:51Z" } ], "nextCursor": null}API keys
Section titled “API keys”- In the app, go to Settings, then API keys. Only owners and admins can make keys.
- Give it a Name that says what uses it, such as “Nightly export”.
- Under Sites, choose Every site or one. A key for one site can’t see or change any other.
- Under It can, tick only what it needs.
- Choose Make a key, and copy it. It’s shown once, and stored only as a hash.
Send it on every request as a bearer token. Keep it on your server or in your build’s environment, never in anything a browser loads.
- A key is limited twice: by what you ticked, and by the role of the person who made it. It never does more than they can.
- It ends when you revoke it, when the person who made it leaves the workspace, or when its site is removed.
- No key can make, see or revoke keys. That’s done in the app.
Scopes
Section titled “Scopes”| Scope | In the app | Allows |
|---|---|---|
account:read |
every key has it | the workspace, its sites and their usage |
forms:read |
Read forms | forms, drafts, revisions, live config, connections (masked), recipients |
forms:write |
Build and publish forms | make, edit and publish forms; edit live config; recipients and dev tokens |
submissions:read |
Read submissions | submissions, spam, people who left part way, deliveries, exports |
submissions:write |
Change submissions | mark spam and not spam, delete, resend |
connections:write |
Change where submissions go | add, change and remove connections |
payments:write |
Connect a Stripe account | connect a Stripe account for payments |
people:write |
Find and erase a person’s data | find and erase one person’s data. Owners and admins only. |
A missing scope answers 403 forbidden. Something in another workspace answers 404, so IDs can’t be probed.
Who you are
Section titled “Who you are”- GET
/v1/me - Who this key or sign-in is: the person, the workspace and its plan, their role and what it can do.
- POST
/v1/sign-out - Ends the sign-in whose token you send. An API key is revoked in the app instead.
Conventions
Section titled “Conventions”- JSON in and out, with camelCase names, the same as the form format.
- Unknown properties are refused with
400 bad_request, so a typo in a script shows up at once. Ignore properties you don’t know in responses: they grow over time. - Times are RFC 3339 in UTC, such as
2026-11-12T09:41:07Z. Dates in answers stayYYYY-MM-DD, in the form’s time zone. - Money is an integer in minor units plus a currency:
{ "amount": 8250, "currency": "AUD" }is $82.50. - Every response carries
Seaforms-Request-Id. Quote it when you ask us about a problem. - The version is in the path. Within
/v1, changes only ever add things.
What’s next
Section titled “What’s next”- Errors, and Lists, retries and edits: how every endpoint behaves.
- Sites, Forms and publishing, Submissions, Connections and deliveries.
- Limits.
ChatGPT is a trademark of OpenAI, and Claude and Claude Code are trademarks of Anthropic. Other product names and logos belong to their owners. None of them makes or endorses Seaforms. Trademarks