Entry

An Entry is created when a user or system submits data to a form. The entry payload is validated against the form’s field definitions: required fields must be present, option values must be valid, and conditional dependency rules are enforced. Each entry is scoped to a single form and stores the submitted data as a key-value payload.

Sample Object

{
  "id": "ent_ghi789jkl012",
  "form_id": "frm_abc123def456",
  "payload": {
    "rating": 5,
    "comment": "Excellent service"
  }
}

Fields

Field	Type	Description
`id`	string	Unique identifier for the entry. Auto-generated on creation.
`form_id`	string	Identifier of the form this entry was submitted to.
`payload`	object	Key-value map of submitted data. Keys must match field names defined in the form schema.

Actions

Submitting an entry to a form

Submit data to a form. The payload is validated against the form schema: required fields are enforced, values are checked against allowed options, and conditional dependency rules are evaluated. Unexpected fields are removed from the payload.

Entry submission is available through the SDK and REST API.

POST /api/v1/forms/frm_abc123def456/entries

{
  "rating": 5,
  "comment": "Excellent service"
}

Successful response

{
  "id": "ent_ghi789jkl012",
  "form_id": "frm_abc123def456",
  "payload": {
    "rating": 5,
    "comment": "Excellent service"
  }
}

Getting an entry by ID

Retrieve a single entry by its entry ID.

Entry management is available through the SDK and REST API.

GET /api/v1/forms/frm_abc123def456/entries/ent_ghi789jkl012

Successful response

{
  "id": "ent_ghi789jkl012",
  "form_id": "frm_abc123def456",
  "payload": {
    "rating": 5,
    "comment": "Excellent service"
  }
}

Listing all entries for a form

Retrieve all entries submitted to a specific form.

Entry management is available through the SDK and REST API.

GET /api/v1/forms/frm_abc123def456/entries

Successful response

{
  "items": [
    {
      "id": "ent_ghi789jkl012",
      "form_id": "frm_abc123def456",
      "payload": {
        "rating": 5,
        "comment": "Excellent service"
      }
    },
    {
      "id": "ent_mno345pqr678",
      "form_id": "frm_abc123def456",
      "payload": {
        "rating": 3,
        "comment": "Average experience"
      }
    }
  ]
}

Deleting an entry

Delete a single entry by its entry ID.

Entry management is available through the SDK and REST API.

Field