Forms

A public form: its title, description, fields, conditions and settings

GET /api/forms/{formToken}

Access: anyone.

Parameters

Responses

• 200 Success
  • title string required
  • description string | null required
  • hasCover boolean required
  • hasLogo boolean required
  • submitLabel string required
  • afterSubmit "message" | "redirect" required
  • submitMessage string | null required
  • redirectUrl string | null required
  • showBranding boolean required
  • entries array of object required
    • fieldId string (uuid) required
    • label string
    • helpText string
    • required boolean
    • allowPrefill boolean
    • condition object | null
      • conjunction "and" | "or" required
      • conditions array of object required
    • viewIdForRecordSelection string (uuid) | null
  • fields array of object required
    • id string (uuid) required
    • name string required
    • type "singleLineText" | "longText" | "number" | "currency" | "percent" | "checkbox" | "date" | "dateTime" | … required
    • options any required
    • isPrimary boolean required
  • captchaSiteKey string | null required
  • accepting boolean required
• 429 Too many requests: a rate limit was reached (see Retry-After)

A linked record field's picker: records of the form's chosen view, by primary field only

GET /api/forms/{formToken}/fields/{fieldId}/records

Access: anyone.

Parameters

Responses

• 200 Success
  • records array of object required
    • id string (uuid) required
    • name string required
  • nextOffset integer | null required
• 422 The request failed validation
• 429 Too many requests: a rate limit was reached (see Retry-After)

Submit the form: creates one record (once per submissionId)

POST /api/forms/{formToken}/submissions

Access: anyone.

Parameters

Request body

• submissionId string (uuid) required
• fields object required
• captchaToken string

Responses

• 201 Success
  • submitted true required
• 422 The request failed validation
• 429 Too many requests: a rate limit was reached (see Retry-After)

Announce a file for an attachment field on the form; answers a presigned PUT

POST /api/forms/{formToken}/attachments

Access: anyone.

Parameters

Request body

• fieldId string (uuid) required
• filename string required
• type string | ""
• size integer required

Responses

• 201 Success
  • attachment object required
    • id string required
    • filename string required
    • size integer required
    • type string required
    • width integer
    • height integer
  • upload object required
    • method "PUT" required
    • url string (uri) required
    • headers object required
    • expiresAt string (date-time) required
• 422 The request failed validation
• 429 Too many requests: a rate limit was reached (see Retry-After)

Confirm a form upload: the stored object must match the announced size

POST /api/forms/{formToken}/attachments/{attachmentId}/confirm

Access: anyone.

Parameters

Responses

• 200 Success
  • id string required
  • filename string required
  • size integer required
  • type string required
  • width integer
  • height integer
• 429 Too many requests: a rate limit was reached (see Retry-After)