Forms API endpoints
The public API is read-only. It lists your forms, returns one form with its fields and returns a form's responses. Every request is authenticated with a personal key; create one in API keys.
Authentication
Send the key as Authorization: Bearer <key> or in the X-API-Key header. A missing, malformed or revoked key returns 401. A key restricted to domains refuses a browser call from an unlisted origin with 403.
curl https://forms.centralyn.com/api/v1/me \ -H "Authorization: Bearer frm_..."
Endpoints
| Method | Path | Returns |
|---|---|---|
GET | /api/v1/me | The account and key behind the token. This call is free. |
GET | /api/v1/forms | Form summaries: id, title, description, published, field count, response count and timestamps. |
GET | /api/v1/forms/:id | One form with its fields and response count. |
GET | /api/v1/forms/:id/responses | Up to 500 of the newest responses, with file answers resolved to URLs. |
The list and every detail route return only the key owner's forms. Unknown, malformed and other-account ids all return 404.
Responses
curl https://forms.centralyn.com/api/v1/forms/<id>/responses \ -H "Authorization: Bearer frm_..."
Each response carries its answers object keyed by field id, a files map for file fields and the submission timestamp. File URLs are public and immutable.
- Text answers are strings, numbers are numbers and checkboxes are booleans.
- A file answer is an array of file objects with name, MIME type, size and URL.
- A file deleted after the response is simply absent from the array.
Quotas and headers
Every authenticated call except /api/v1/me consumes one call from the key owner's monthly plan quota. The key's own hard limit is checked first. Responses carry X-Api-Calls-Limit, X-Api-Calls-Used, X-Api-Calls-Remaining and X-Api-Calls-Reset, plus the key counters when the key has a limit.
Status codes
| Status | Meaning |
|---|---|
200 | The request succeeded. |
401 | The key is missing, malformed or revoked. |
403 | The key's domain allowlist refused the browser origin. |
404 | The form or API path does not exist for this key. |
405 | The method is not supported on that endpoint. |
429 | The monthly quota or the key's hard limit is spent; see Retry-After and the meter headers. |
OpenAPI
/openapi.json serves an OpenAPI 3.1 description of the same endpoints for generated clients.