DatumForms.
Join the panel Sign in Create a survey

DATUMFORMS DOCUMENTATION

Authenticate API requests

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

For developers

Updated 15 November 2026

On this page

Project API keys

Create keys in Project Settings → API keys. Send the secret over HTTPS in Authorization: Bearer YOUR_API_KEY. The developer endpoint is https://app.datumforms.com/api/developer-api; the supplementary uploader is /api/csv-import. A key belongs to one project and its permissions and restrictions are checked on every request.

GET requests use query parameters. POST requests use JSON with operation, data and idempotency_key. The retry identity must contain 8–100 letters, digits, colons, underscores or hyphens. Use a separate identity for every logical write and preserve it for retries.

Application sessions

The recruitment endpoint /api/panel authenticates the application session using Authorization: Bearer YOUR_SESSION. The actor must administer the selected project. Session credentials and project API keys are different credential types; use the authentication required by each endpoint.

For responses:read:self, send the signed-in application’s session in Authorization and the restricted key in X-API-Key. The response list uses the session’s respondent identity. Without a valid session it returns 401.

Permissions and scope

Group-restricted keys can access permitted collection data. Field-restricted keys support response reads; they cannot read bulk collection details. Shared form and custom-code authoring uses project-wide access because a page or resource can affect multiple collections. location:read is additional to response access. collection:read is additional when requesting response metadata.

Check the result

Start with account.get using an account-read key, or a scoped responses.list request for a reporting key. A successful response has success: true. Test denied scope as well as the allowed path.

Troubleshooting

A 401 means missing, expired or revoked authentication. A 403 means the actor, permission or resource scope does not authorize the request. Check the project and key creator’s current role. Keep credentials out of URLs, source control, screenshots and logs.

Run the quickstart or manage key expiry and revocation.

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