Programmatic access to the resources you manage in the FieldScroll
dashboard. Mint an API key, send a request with Authorization: Bearer fs_live_..., get back a JSON envelope.
Base URL
https://fieldscroll.app/api/v1
Local development:
http://localhost:3000/api/v1
What you can do
| Resource | Read | Create | Update | Delete | Actions |
|---|---|---|---|---|---|
| Instance settings | ✓ | — | ✓ | — | — |
| Organizations | ✓ | ✓ (instance keys) | ✓ | ✓ soft (instance keys) | — |
| Users (instance-wide) | ✓ | — | ✓ | ✓ soft | — |
| Organization members | ✓ | ✓ | ✓ (roles) | ✓ | assign-forms |
| Forms | ✓ | ✓ | ✓ | ✓ soft | publish, assign-users |
| Records | ✓ | ✓ | ✓ | ✓ | — |
| Data sources + rows | ✓ | ✓ | ✓ | ✓ soft | bulk row insert (≤1000) |
| Webhook subscriptions | ✓ | ✓ | ✓ | ✓ | deliveries list + retry |
| Report templates | ✓ | ✓ | ✓ | ✓ | merge, deliveries list + retry |
Quick start
# Set your key
export FS_KEY="fs_live_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
# Health check (unauthenticated)
curl https://fieldscroll.app/api/v1/health
# List your organizations
curl -H "Authorization: Bearer $FS_KEY" \
https://fieldscroll.app/api/v1/organizationsInteractive reference
The reference page links the try-it-out UI, the OpenAPI 3.1 spec, and a Postman collection.
Topic guides
- Authentication — API keys, scopes, environments, rotation
- Conventions — HTTP methods, status codes, envelopes
- Pagination — cursors, limit, sort
- Idempotency — replay-safe POST and PATCH
- Rate limiting — limits, headers, retry guidance
- Webhooks and the API — what fires, what doesn't
- MCP server — lets AI tools search these docs and read your forms and records; seven tools can also write, and only with a key you grant write scopes to
- QR codes and deep links — open a form in the mobile app from a printed code, with fields already filled in
- Health and uptime — the
/healthendpoint and monitoring guidance - Examples — curl and JavaScript snippets per resource