API reference
API overview
Send submissions from any website, app or server, and read forms and submissions back from your own code. Every endpoint speaks JSON over HTTPS.
Base address
Base URL
https://switchyard-ccn.modulify.websiteEndpoints
| Method and path | What it does | Signs in with |
|---|---|---|
POST /api/in/{key} | Send a submission to a form | The source key in the path. An API key is optional. |
GET /api/v1/submissions | List submissions, newest first | API key |
GET /api/v1/submissions/{id} | Read one submission with its runs and files | API key |
GET /api/v1/forms | List forms and the fields they accept | API key |
GET /api/v1/forms/{id} | Read one form | API key |
Authentication
Create an API key on the API keys page of your workspace (admins and owners). The key is shown once. Send it in the Authorization header:
Header
Authorization: Bearer sy_live_your_api_key- A key belongs to one workspace and reads everything in it, so keep it on your server and never put it in a web page.
- On the submission endpoint, a key is optional. With one, the request skips the allowed websites check and the bot check, which is what server-to-server senders such as your backend need.
- Revoke a key on the API keys page and it stops working right away.
Requests and answers
- Answers of the read endpoints are JSON objects with a
dataproperty. - Errors are JSON objects with a
messageyou can show people and acodeyou can branch on. See Errors and limits. - Times are ISO 8601 in UTC, such as
2026-11-20T09:30:00.000Z. - Answers are never cached, so you always read the current state.
Rate limits
| What | Limit |
|---|---|
| Read endpoints | 60 requests a minute per API key, then 429 with a Retry-After header |
| Submission endpoint | 120 submissions a minute per address, plus the hourly limit per visitor set on each form |
| Monthly submissions | Set by your plan. See Plans and limits. |