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
| Status | When |
|---|---|
| 400 | The body is empty, or is not valid JSON, or is JSON that is not an object. |
| 401 | An API key was sent and it is not valid for this workspace. |
| 403 | The request came from a website that is not allowed, or the form or the source is paused. |
| 404 | No source has this key. Check the address in the Connect tab. |
| 405 | A method other than POST, GET or OPTIONS. |
| 413 | The request, the answers or a file is over its limit. |
| 415 | The content type is not JSON, a form post or a multipart upload. |
| 429 | Too many submissions from one address, or the workspace reached its monthly submissions. |
| 500 | Something failed on our side. It is safe to try again with the same Idempotency-Key. |
Read endpoints
| Status | Code | When |
|---|---|---|
| 400 | invalid-status | The status filter is not one of the listed values. |
| 401 | unauthenticated | No API key was sent. |
| 401 | invalid-key | The key is wrong or was revoked. |
| 404 | not-found | No form or submission with that id in this workspace. |
| 405 | method-not-allowed | Use GET. |
| 429 | rate-limited | More than 60 requests in a minute with this key. Wait for the seconds in Retry-After. |
| 500 | server-error | Something failed on our side. Try again shortly. |
All limits in one place
| Limit | Value |
|---|---|
| Read requests per API key | 60 a minute |
| Submissions per address | 120 a minute, plus each form's hourly limit per visitor |
| Request size | 25 MB, with 64 KB of answers and up to 10 files of 10 MB |
| Duplicate window | 10 seconds for identical answers, 24 hours for an Idempotency-Key |
| Page size | Up to 100 submissions per request |
| Monthly submissions, forms, flows and more | Depends on your plan |