Request
GET https://app.datumforms.com/api/developer-api
Operation: responses.list
Permissions: responses:read.
Read paginated responses and answer cells. Optional filters (question_ref, operator, value), limit up to 1000, and include_location=true with location:read.
Send operation as a query parameter for GET, or a top-level JSON member for POST. Every POST also needs idempotency_key (8–100 permitted characters). Fields marked data belong inside the JSON data object.
| Parameter | Location | Type | Required | Meaning |
|---|---|---|---|---|
group_id |
query | integer | No | Optional group ID. All allowed groups when omitted. |
alias |
query | string | No | Stable group reference; if also supplying group_id, they must agree. |
after_id |
query | integer | No | Last response ID from next_cursor. Default 0. |
limit |
query | integer | No | Page size, default 100, maximum 1000. |
filters |
query | string | No | JSON array of question_ref, operator and value. Operators: eq, ne, in, contains; combined with AND. |
include_collection_details |
query | boolean | No | Include collection_details. Needs collection:read and no field restrictions. |
include_location |
query | boolean | No | Include captured_location and reference_location. Needs location:read. Anonymous and panel coordinates are null. |
Response
Successful results contain success: true plus these operation fields. Fields returned by shared form and resource services retain their normal definitions.
| Field | Type or shape |
|---|---|
responses |
Response[] |
next_cursor |
integer or null |
See schemas for answer cells, responses and collection details. Use IDs from your project: groups.list returns group IDs, surveys.get returns page/question IDs, and responses.list returns response IDs and revisions.
Examples
Set DATUMFORMS_API_KEY. Replace example IDs with IDs returned by the preceding reads. Replace docs-run-001 with your persisted job identity. Write examples perform the named operation; keep the exact request and identity unchanged when retrying. JavaScript and Python examples use the downloadable clients.
cURL
curl --fail-with-body --get 'https://app.datumforms.com/api/developer-api' \
-H "Authorization: Bearer $DATUMFORMS_API_KEY" \
--data-urlencode 'operation=responses.list' \
--data-urlencode 'group_id=123' \
--data-urlencode 'after_id=0' \
--data-urlencode 'limit=100'
JavaScript
import { request } from './client.mjs';
const result = await request("GET", {
"operation": "responses.list",
"group_id": 123,
"after_id": 0,
"limit": 100
});
console.log(JSON.stringify(result, null, 2));
Python
import json
from client import request
payload = json.loads('{"operation": "responses.list", "group_id": 123, "after_id": 0, "limit": 100}')
result = request('GET', payload)
print(json.dumps(result, indent=2))
Pagination and errors
Follow next_cursor using after_id until null. For 400, check required values and types; for 401, check authentication; for 403, check permissions and project scope; for 404, check the resource ID. See error recovery and the operation index.