Forms

Get one form submission with every field

Returns one submission by id, with the full fields payload. Submissions hold visitors' personal data, so this needs at least the editor role on the site. A viewer gets 403 forbidden_role.

get/api/v1/sites/{slug}/form-submissions/{id}

Request

  • Base URL: https://api.dotsy.ai
  • URL: https://api.dotsy.ai/api/v1/sites/{slug}/form-submissions/{id}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

slugstring required
Example:acme-studio

Site slug or site id (UUID). An old slug answers 301/308 and a site id 307 to the canonical slug path.

idstring required
Example:5b1c0f6e-3c1a-4a52-9f4e-0d7a2d9b8e31

Submission id, from the id of a listed submission.

Response

The submission.

idstring required

Submission id.

formIdstring required

The form this was submitted through.

pagePathstring nullable required

Path of the page the visitor submitted from, when known.

fieldsobject required

What the visitor filled in: field name to value. Personal data lives here.

replyTostring nullable required

The visitor's email address, when the form has one. Use it to search.

metaobject nullable required

Extra facts about the submission, such as a hash of the visitor's IP address (ip_hash).

sizeBytesinteger required

Size of the stored submission in bytes.

createdAtinteger required

When it was submitted, Unix ms.

Example response

{
  "id": "5b1c0f6e-3c1a-4a52-9f4e-0d7a2d9b8e31",
  "formId": "contact",
  "pagePath": "/contact",
  "fields": {
    "name": "Ada Lovelace",
    "email": "ada@example.com",
    "message": "Do you take custom orders?"
  },
  "replyTo": "ada@example.com",
  "createdAt": 1790000000000
}

Changes

No recorded changes to this operation across all 1 revision of this API.