API

API reference

Endpoint and schema reference for Formlism developer APIs.

Endpoints

MethodPathResponse
GET/api/developer/forms{ forms, pagination }
POST/api/developer/forms201 { form }
GET/api/developer/forms/:formId{ form }
PATCH/api/developer/forms/:formId{ form }
DELETE/api/developer/forms/:formId204
GET/api/developer/forms/:formId/metadataformMetadata
GET/api/developer/forms/:formId/responses{ responses, pagination }
POST/api/developer/forms/:formId/duplicate201 { form }
POST/api/developer/forms/:formId/publish{ form }
POST/api/developer/forms/:formId/unpublish{ form }

Form fields

  • id: UUID
  • title: required string, 1 to 255 characters
  • description: string up to 5000 characters, or null
  • questions: array of shallow JSON objects
  • settings: shallow JSON object
  • tags: array of strings, each up to 100 characters
  • published: boolean
  • folder_id: UUID or null
  • created_at and updated_at: ISO datetimes

Write fields

Create requires title. Update requires form_id in the validated input and at least one update field. The route reads form_idfrom the URL path.

Status codes

  • 200: request succeeded
  • 201: form or duplicate created
  • 204: form deleted
  • 400: invalid ID, query, or payload
  • 401: missing, invalid, or revoked API key
  • 404: form not found or inaccessible
  • 429: rate limit exceeded
  • 500: internal server error