SynckHub Platform API

SynckHub platform API is repo-scoped and item-centric.

High-value endpoint families

  • items and folders: create, move, rename, metadata, lifecycle
  • repo users and access introspection
  • authz rules, groups, effective permissions, authz events
  • metadata and full-text search
  • audit events: /repos/{repo_id}/audit/events
  • blob, content, and version-history surfaces

What the data plane is responsible for now

Depending on feature flags and edition, the data plane may also expose:

  • shared links and public browse or download flows
  • tus upload intent and finalize flows
  • Office WOPI and Yjs session lifecycles
  • connected mail and calendar operations
  • structured-data and case-oriented operations
  • folder-backed company and contact entity views

That does not change the rule: repository context is still the center of gravity.

Working pattern

  1. resolve repo_id and API base URL via Common directory
  2. send authenticated request to the owning SynckHub API base
  3. enforce least-privilege assumptions in client UX

Contract notes

Community and enterprise authz modes differ. Design client behavior around explicit permission checks, not role-name shortcuts.

Common mistakes

  • hard-coding one API base URL for all repos
  • inferring permissions from UI roles instead of checking server behavior
  • bypassing upload, save, or finalize lifecycles because they look inconvenient
  • assuming companies, contacts, cases, mail, and calendar all behave like plain files or folders in the API