Skip to content

API reference

Errors and limits

Every error comes with a status code and a message written for people. Read endpoints add a code you can branch on.

Error shape

Read endpoints
{
  "message": "That API key is not valid. It may have been revoked.",
  "code": "invalid-key"
}
Submission endpoint
{
  "ok": false,
  "message": "This form is paused, so it is not taking submissions right now."
}

Submission endpoint

StatusWhen
400The body is empty, or is not valid JSON, or is JSON that is not an object.
401An API key was sent and it is not valid for this workspace.
403The request came from a website that is not allowed, or the form or the source is paused.
404No source has this key. Check the address in the Connect tab.
405A method other than POST, GET or OPTIONS.
413The request, the answers or a file is over its limit.
415The content type is not JSON, a form post or a multipart upload.
429Too many submissions from one address, or the workspace reached its monthly submissions.
500Something failed on our side. It is safe to try again with the same Idempotency-Key.

Read endpoints

StatusCodeWhen
400invalid-statusThe status filter is not one of the listed values.
401unauthenticatedNo API key was sent.
401invalid-keyThe key is wrong or was revoked.
404not-foundNo form or submission with that id in this workspace.
405method-not-allowedUse GET.
429rate-limitedMore than 60 requests in a minute with this key. Wait for the seconds in Retry-After.
500server-errorSomething failed on our side. Try again shortly.

All limits in one place

LimitValue
Read requests per API key60 a minute
Submissions per address120 a minute, plus each form's hourly limit per visitor
Request size25 MB, with 64 KB of answers and up to 10 files of 10 MB
Duplicate window10 seconds for identical answers, 24 hours for an Idempotency-Key
Page sizeUp to 100 submissions per request
Monthly submissions, forms, flows and moreDepends on your plan
Made with Modulify