Synctactic developer referenceFormStudio API · Version 1
Reports & collaboration

Connect your app to FormStudio.

Keep report layouts, shared history, permissions and previews consistent across devices using the same main portal account.

Authenticated

Send your existing portal token as Authorization: Bearer …. Report roles are checked on every operation.

Offline friendly

Queue local edits and retry identical mutation IDs after reconnecting. Versioned sync preserves conflicting edits.

One API namespace

/v1/formstudio contains report services. Original /api/… endpoints remain compatible.

Quick start

Sign in through the main portal first. Use https://api.synctacticsystems.com; the same versioned routes are also served at https://forms.synctacticsystems.com.

curl https://api.synctacticsystems.com/v1/formstudio/collaboration \
  -H "Authorization: Bearer $PORTAL_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"action":"list","offset":0}'

Never include a token in a URL or share it in a support ticket. Browser origins must be explicitly allowed. CORS does not grant access to reports.

Errors & retry

400 invalid input · 401 sign in again · 403 insufficient access · 404 unavailable report or preview · 409 stale version · 503 retry with increasing backoff. Record the X-Request-Id response header when reporting a problem.

Endpoint reference

Loading API reference…

Collaboration actions

Send actions to POST /v1/formstudio/collaboration. Report operations require id; creation and library listing are exceptions.

ActionPurposePermission

Integration notes

Reports & exports

The API stores report designs and reads app data. SQL evaluation and PDF, Office and image exports currently run in the FormStudio engine. No server export endpoint is published.

Presence

Send a unique session UUID for each open workspace, keep heartbeats active within the 25-second presence window, and send leave: true on close. Mobile clients can send activity without a cursor.

Support

Include the endpoint, status, timestamp and request ID. Omit bearer tokens and sensitive report content. Owners manage invitations and link permissions in Share report.