DatumForms.
Join the panel Sign in Create a survey

DATUMFORMS DOCUMENTATION

Understand API response and answer schemas

Interpret resource IDs, answer cells, revisions and collection metadata consistently.

For developers

Updated 15 November 2026

On this page

Resource identity

Field Meaning Source
project_id Project workspace account.get
group_id / collection_id Collection holding responses groups.list, groups.save
form_id Authored question page surveys.get, surveys.save
survey_id Versioned survey attached to a collection Recruitment survey listing / survey definition
version_id Original definition attached to a response responses.list
questionRef / form_elements_id Stable question reference Published form definition / answer cells
response_id / response id One saved response responses.list
study_id Recruitment study UUID create_study

Response

responses.list returns success, responses and next_cursor. Each response contains id, collection_id, version_id, status, revision, submitted_at and answers. Optional metadata and locations appear when requested and authorized. A null cursor is the last page.

Saved answer cells

Each saved cell identifies response_id, form_elements_id, row, col and field_response_value. Scalar coordinates can be null. Matrix coordinates refer to the original published definition; keep them unchanged. Choice interpretation uses canonical identities and the original version.

Imported or corrected answer cells

{"questionRef": 456, "value": "ITEM-001", "row": null, "col": null}

Supply 1–2000 unique cells. References must be positive IDs in the original response definition. Values are strings, numbers or null; text values are limited to 100,000 characters. Coordinates are nonnegative integers up to 10,000. A null correction removes that cell. Data writes require an audit reason and current revision when editing.

Collection details

Bulk collection_details includes response_id, version_id, version_number, revision, status, started_at, submitted_at, last_received_at, environment, legacy_collection_details, captured_location and reference_location when available.

environment can include platform, browser version, screen and viewport width/height, pixel ratio, language, timezone, touch points, app version and collection mode. Location objects contain latitude, longitude and accuracy; absent or privacy-excluded locations are null.

collection.get wraps the detailed object in collection, adding sync_history, location_corrections and its history cursor. Recorded data varies by original collection. Device capture and server receipt are separate times; manual corrections are separate annotations.

Errors and concurrency

Failures use success: false and message with an HTTP status. Successful replayed writes also return replayed: true. Use response revision, form edit_hash, alias revision, publication review_token and import review_token for the specific operation that returned them.

Operation reference · OpenAPI specification · Error recovery.

Need help with this task? Contact DatumForms. Include the article URL and the step you reached.

Tracking preferences

Essential functions stay on. Choose whether to allow optional tracking on this website. You can change your choices in the footer at any time.

Read our privacy policy