The full endpoint-by-endpoint reference is generated from the same schemas that validate every request, so it never drifts from the deployed API.
Interactive reference
fieldscroll.app/api/v1/docs renders every endpoint with request and response schemas, and lets you send real requests against your own API key.
OpenAPI spec
The OpenAPI 3.1 document is served at
fieldscroll.app/api/v1/openapi.json.
Use it to generate typed clients — openapi-typescript,
openapi-generator, and similar tools consume it directly.
Postman collection
Download the prebuilt collection: fieldscroll-v1.postman_collection.json
To set it up:
- In Postman, File → Import, then drop the downloaded file. The collection imports as FieldScroll Customer API.
- The collection ships with collection-level bearer auth reading
{{bearerToken}}. - Add a
bearerTokenvalue to your Postman environment with a key minted at/api-keysin your dashboard.
Notes:
- Per-request example bodies are generated from the API schemas; edit them in Postman to match your real payloads.
- The collection does not auto-paginate. For production scripts, prefer the curl or JavaScript examples.
Endpoint groups
| Group | Base path | Covers |
|---|---|---|
| Health | /health | Unauthenticated uptime probe |
| Instance | /instance | Workspace settings read + update |
| Organizations | /organizations | List, create, update, deactivate |
| Users | /users | Workspace-wide user directory |
| Members | /organizations/{org}/users | Membership, roles, form assignment |
| Forms | /organizations/{org}/forms | Drafts, publish, assign users |
| Records | /organizations/{org}/forms/{form}/records | Submit, read, update, delete, dispatch |
| Data sources | /organizations/{org}/data-sources | Reference tables + bulk rows |
| Webhooks | /organizations/{org}/webhooks | Subscriptions, deliveries, retry |
| Reports | /organizations/{org}/reports | Templates, destinations, merge, deliveries |
Three notes on what these do to people rather than data:
DELETEon an organization deactivates it. It does not erase anything: members lose access at once and are signed out when this was their only organization, while records, forms, and media stay in place. It matches the dashboard's deactivate button exactly. See organizations.- Webhook delivery history reaches back 90 days. Older deliveries and their payloads are removed, as described in webhooks.
- Report destinations can be created and edited through the API, but two things about them only happen in the dashboard. Signing secrets are write-only: a read returns a flag saying whether one is set, never the value. And a Box or Google Drive destination is saved first and authorized afterwards — the sign-in with Box or Google, and picking the folder, happen on the report's page. See reports.