Submission

Definition

Property Type Description
id String ID
formId String Form ID
workspaceId String Form's Workspace ID
createdAt String Time of creation (ISO 8601)
lastModifiedAt String Time of last modification (ISO 8601)
receivedAt String Time of receipt at server (ISO 8601)
distribution String

Distribution source

Values:
  • Group
  • Web
  • Email
userId String

User's ID (if made via Group distribution)

Nullable
email String

User/participant's e-mail address (if Group or Email distribution)

Nullable
data Object

An object using the field's name as key and submitted data as value.

The data type of the value is determined by the dataType of the related field (see below). Multiple values may be provided as an array.

If data was not provided for a field, it may either be excluded or provided as null.

Field Type Mappings

Data Type Value Type Value Format
Attachment Attachment -
Date String YYYY-MM-DD
Number Number -
Png String Base64-encoded binary
String String -
Time String HH:MM

Example

{
    "id": "060ba8b4-8304-4f68-86ab-d1aca9014d75",
    "formId": "5f6ef4d8-1be3-4af1-a10b-be45d0187fce",
    "workspaceId": "1ecab824-75e8-4519-8a7a-a5c413e47162",
    "createdAt": "2024-03-02T13:14:15Z",
    "lastModifiedAt": "2024-03-02T13:14:15Z",
    "receivedAt": "2024-03-02T13:14:15Z",
    "distribution": "Group",
    "userId": "6a27ddf9-15a8-405a-9981-0bf8c50d8df0",
    "email": "example@email.com",
    "data": {
        "a_text_field": "a little response",
        "a_big_text_field": "a multi-line\nresponse",
        "single_choice": "One",
        "multi_choice": ["A", "B"],
        "a_date": "2018-06-01",
        "a_time": "12:30",
        "signature": "<base64 encoded PNG file>",
        "image_upload": {
            "id": "ce46fc89-97c9-438d-9c9a-d492c2ddd310",
            "name": "My Image.jpg",
            "type": "image/jpeg",
            "size": 12345,
            "data": "<base64 encoded file>"
        },
    }
}

results matching ""

    No results matching ""