DatumForms.
Join the panel Sign in Create a survey

DATUMFORMS DOCUMENTATION

Create a read-only survey API key

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

For developers

Updated 15 November 2026

On this page

Before you start

You need project administrator access and the group/question IDs from your survey definitions.

Open: Your project → Project Settings → API keys → Create API key.

Steps

  1. Name the key for its use. Choose Custom JavaScript lookup (read-only) for an approved browser lookup, or Server integration for private reporting.
  2. Give reporting access Read response answers (responses:read). For a self-only browser view, choose Signed-in respondent’s own answers (responses:read:self).
  3. Enter the intended Survey group IDs and Question IDs. A browser lookup requires explicit question restrictions.
  4. Enable Read captured locations only when the lookup needs permitted coordinates. A field-restricted key cannot read bulk collection details.
  5. Set the expiry, create the key and test it against one allowed group and one denied group before distribution.

Check the result

The server enforces the key’s group and question restrictions. A self-only key additionally requires the signed-in respondent’s session.

Troubleshooting

For self-only access, send the application session as Authorization: Bearer and the key as X-API-Key. The authenticated session supplies identity; passing a user ID does not change it.

Next steps

Read responses and metadata.

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