DatumForms.
Join the panel Sign in Create a survey

DATUMFORMS DOCUMENTATION

API documentation

Build surveys, select audiences, launch recruitment and bring versioned responses into your tools.

Get connected

Make your first request, create a key and choose authentication.

Create and publish surveys

Run the complete authoring workflow. Each returned group, page and review identifier feeds the next request.

Read responses and collection details

Read every response page and export data with original versions and collection context.

Run a monthly workflow

Clone, import and activate the next period using stable group references.

Select an audience and recruit

Quote an audience, create a study and launch recruitment. Connect submitted feedback to your own analysis pipeline.

Operation reference

Browse operations and permissions, response schemas and the OpenAPI specification.

Errors and safe retries

Handle pagination, errors and concurrent changes. Keep each logical write’s original retry identity.

Authenticate API requests

Choose project API-key authentication or an authenticated application session for the operation you are running.

Read guide →

Create, review and publish a survey through the API

Create a collection and question page, attach them and publish the reviewed definition.

Read guide →

Export response data from an API job

Write all permitted response pages to CSV or newline-delimited JSON.

Read guide →

Handle API errors, pagination and safe retries

Recover from request failures without repeating a successful write.

Read guide →

Import and replace supplementary data through the uploader API

Verify a CSV, review its proposed changes and apply the approved import.

Read guide →

Make your first DatumForms API request

Read your project summary from cURL, JavaScript or Python.

Read guide →

Read responses and collection metadata through the API

Retrieve every permitted response page and retain its original version and collection context.

Read guide →

Refresh a connected Google Sheet with Apps Script

Queue the existing survey spreadsheet export and check its completion from Apps Script.

Read guide →

Repeat survey collections with stable group references

Clone the published source, load the next period and switch one stable reference.

Read guide →

Select an audience and launch recruitment through the API

Quote an audience, create a study, launch it and monitor collected feedback.

Read guide →

Understand API response and answer schemas

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

Read guide →

Create, edit and revoke a survey API key

Give an integration the exact access it needs and manage its lifecycle.

Read guide →

Create a read-only survey API key

Limit a reporting integration or browser lookup to selected surveys and questions.

Read guide →

API operations and permissions

Find each project API operation, its HTTP method and permission requirements.

Read guide →

Read the project account summary (account.get)

Read the project name, type and plan summary.

Read guide →

List survey groups (groups.list)

List up to 100 groups and their published versions. Continue with after_id.

Read guide →

Open or close survey collection (groups.set_availability)

Set group_id and data.active to open or close response collection through the existing publication and plan checks.

Read guide →

Create or edit a survey group (groups.save)

Create a group with data.name, or edit one with data.group_id.

Read guide →

Attach a question page to a survey (groups.assign_form)

Attach data.form_id to group_id as a draft change.

Read guide →

Read saved survey definitions (surveys.get)

Read form definitions. Provide form_id for one form.

Read guide →

Create or edit a question page (surveys.save)

Save draft pages and elements. Existing forms require form_id and expected_edit_hash.

Read guide →

Review survey publication changes (surveys.review)

Review unpublished changes for group_id; retain review_token.

Read guide →

Publish a reviewed survey (surveys.publish)

Publish the reviewed draft with group_id and data.review_token.

Read guide →

Assign an ordinary participant (assignments.save)

Create an ordinary participant assignment with their existing email and groups_id.

Read guide →

Read custom JavaScript and CSS resources (resources.get)

Read custom JavaScript/CSS resources; optionally select resource_id.

Read guide →

Create or edit a custom code resource (resources.save)

Save code_title, js_css, resource_type and resource_value; include id to edit.

Read guide →

Delete a custom code resource (resources.delete)

Delete the custom resource identified by data.id.

Read guide →

List responses and saved answer cells (responses.list)

Read paginated responses and answer cells. Optional filters (question_ref, operator, value), limit up to 1000, and include_location=true with location:read.

Read guide →

Import an ordinary response (responses.create)

Import ordinary responses with group_id, data.reason and data.answers.

Read guide →

Correct an ordinary response (responses.update)

Correct ordinary answers using response_id, expected_revision, reason and answers.

Read guide →

Delete an ordinary response (responses.delete)

Delete an ordinary response with expected_revision and reason; files/judging history prevent deletion.

Read guide →

Read collection details and save history (collection.get)

Read device/browser, screen/window, timing, location, survey version and received-save details for response_id. Use after_operation for more history.

Read guide →

Annotate an ordinary response location (location.correct)

Annotate an ordinary response with corrected latitude/longitude, expected_revision and reason.

Read guide →

Create the next monthly collection (monthly.create)

Clone a published source into a draft group using source_group_id, expected_source_version_id and name.

Read guide →

Read a stable group reference (aliases.get)

Resolve alias to its current group_id and revision.

Read guide →

Switch a stable group reference (aliases.set)

Switch data.alias to published group_id with data.expected_revision; use 0 for a new alias.

Read guide →

Configure a participant data lookup (lookups.save)

Configure a participant lookup with name, collection_aliases and question_refs. Set active:false to disable.

Read guide →

List project participants (members.list)

Read the permitted project participant roster, paginated with page; optionally filter by group_id.

Read guide →

Check spreadsheet refresh status (sheets.status)

Read the connected spreadsheet and refresh state for group_id.

Read guide →

Refresh a connected spreadsheet (sheets.refresh)

Queue the existing Google Sheets export for group_id.

Read guide →

List read-only lookup key groups (keys.lookup_groups)

Read the group policies of read-only lookup keys. Secrets are never returned.

Read guide →

Update a lookup key’s allowed groups (keys.update_lookup_groups)

Update a read-only lookup key using key_id, collection_ids and expected_collection_ids.

Read guide →

Stop recruitment with a project API key (recruitment.stop)

Pause new recruitment for data.study_id; existing reservation rules still apply.

Read guide →

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