NourForm Data Access API — Overview
Read-only REST API for accessing forms, responses, and payments using API keys with scope-based permissions.
Base URL
https://api.form.nour-lab.comKey Concepts
- Read-only by default: Keys cannot create, update, or delete resources.
- Scope-controlled: Permissions are granted per key via
forms:read,responses:read, andpayments:read. - Tenant isolation: Requests are scoped to the key owner. Missing/unauthorized access returns 404 (to avoid resource enumeration).
- PII minimized: Personal data is not included by default; sensitive fields are never exposed unless explicitly scoped (and currently not supported).
- Cursor pagination: List endpoints support cursor-based pagination for efficient traversal.
Endpoints
| Method | Path | Scope | Description |
|---|---|---|---|
| GET | /v1/me | — | Get current API key info and scopes |
| GET | /v1/forms | forms:read | List forms owned by key |
| GET | /v1/forms/:formId | forms:read | Get form details |
| GET | /v1/forms/:formId/responses | responses:read | List responses (no PII by default) |
| GET | /v1/forms/:formId/responses/:responseId | responses:read | Get single response |
| GET | /v1/forms/:formId/payments | payments:read | List payments derived from responses |