Skip to content

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.website

Endpoints

Method and pathWhat it doesSigns in with
POST /api/in/{key}Send a submission to a formThe source key in the path. An API key is optional.
GET /api/v1/submissionsList submissions, newest firstAPI key
GET /api/v1/submissions/{id}Read one submission with its runs and filesAPI key
GET /api/v1/formsList forms and the fields they acceptAPI key
GET /api/v1/forms/{id}Read one formAPI 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 data property.
  • Errors are JSON objects with a message you can show people and a code you 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

WhatLimit
Read endpoints60 requests a minute per API key, then 429 with a Retry-After header
Submission endpoint120 submissions a minute per address, plus the hourly limit per visitor set on each form
Monthly submissionsSet by your plan. See Plans and limits.
Made with Modulify