Raw Responses Scope

The RawResponsesRead scope grants access to current individual response rows for surveys in the tenant. This is the most sensitive integration scope and should be granted only when the integration contract explicitly requires row-level data.

Required Scope

RawResponsesRead

The tenant's effective plan must also enable Raw response API access, retain the client within External integrations, and pass the active-tenant and subscription checks.

When to Use This Scope

Use the RawResponsesRead scope when your integration needs:

Per-submission metadata, status, and answer counts that aggregate reports do not provide.
Actual answer values for a selected response.
Current response-file descriptors and authorized file downloads.
Export of current submission and answer data to a data lake or data warehouse.
Compliance or audit scenarios requiring individual submission records.

The response-list endpoint returns metadata only. The dedicated response-answers endpoint returns actual answer values, including free-text values where present, while file content remains on the separate download endpoint. The current integration contract does not expose a respondent identity field.

Do not use this scope simply because it is available. If aggregate report data from the ReportsRead scope satisfies the integration's requirements, prefer that scope.

Available Endpoints

List Tenant Responses

Returns a paged bare array of response metadata across the tenant. There is no survey or submitted-date filter in the current endpoint.

GET /api/integrations/reports/raw-responses?page=1&pageSize=50

Query parameters:

Parameter	Type	Description
`page`	integer	Page number (1-based). Default: 1
`pageSize`	integer	Results per page. Default: 50, max: 100

Values below 1 are normalized and pageSize is clamped to 100. The response has no total-count envelope. Rows are ordered by createdAt descending and then by unique id descending for deterministic ties.

Response item structure:

[
  {
  "id": 123,
  "surveyId": 45,
  "surveyName": "Customer Satisfaction",
  "createdAt": "2026-06-11T12:00:00Z",
  "status": "Completed",
  "answerCount": 10,
  "files": [
    {
      "answerFileId": 987,
      "answerId": 456,
      "questionId": 12,
      "fileName": "evidence.pdf",
      "fileTypeCode": "PDF",
      "contentType": "application/pdf",
      "sizeBytes": 245760,
      "downloadUrl": "/api/integrations/files/987"
    }
    ]
  }
]

Read One Response's Answers

GET /api/integrations/reports/raw-responses/{responseId}/answers

The same key must carry RawResponsesRead. The response is tenant-scoped and returns 404-equivalent behavior when the response is absent from that tenant. It returns the actual stored answer values and file references; attached file bytes are still read only through the file-download endpoint below.

Download a Current Response File

GET /api/integrations/files/{answerFileId}

The same API key must carry RawResponsesRead. The server resolves a current, non-deleted AnswerFile association inside the key's tenant. The endpoint returns a forced attachment as application/octet-stream, sets Cache-Control: no-store and X-Content-Type-Options: nosniff, and disables range processing. It does not currently set an ETag or a private cache directive. Cross-tenant or deleted associations return 404; the file pipeline separately requires active file metadata. Contracts never expose FileMetadataId, storage paths, encryption metadata, or raw access tokens.

Privacy Considerations

The tenant is responsible for ensuring that its use of response and file metadata complies with applicable data protection regulations (such as GDPR or local equivalents).
The list DTO does not expose answer values, but the dedicated answers endpoint can expose actual response content, including free text. The current integration contract does not expose a respondent identity field. File names and other returned metadata can also be sensitive.
Do not store raw response data in systems that do not have appropriate access controls.

Tenant Isolation

Every raw-response query is automatically scoped to the tenant associated with the API key. It is not possible to retrieve responses for surveys belonging to a different tenant using an integration key.

Raw Responses Scope