Skip to main content

Scope model

The Public API does not mix personal and organisation data.

Client search follows the key scope

GET /clients/search only returns clients visible to the key you used. This means:
  • a user key searches that user’s personal clients
  • an organisation key searches the organisation’s shared clients

Notes, uploads, and generated reports stay in scope

When you create notes, upload files, or generate reports:
  • user-key writes stay in the user’s personal scope
  • organisation-key writes stay in the organisation scope
Organisation-created notes and generated reports are read-only in the current Everbility UI.

Cross-scope access

Cross-scope access is rejected. Examples:
  • a user key cannot fetch an organisation client’s reports
  • an organisation key cannot fetch a personal template
  • note IDs used for report generation must belong to the same client and the same visible scope as the API key