Skip to main content

​
Entity overview

The API is built around these main entities (defined in the OpenAPI spec):
  • User — People in the space. Full profile with name, unit, user types, permissions, avatar, and optional extras (department, groups, specialties).
  • Unit — Organizational units in a tree (e.g. departments, locations). Have id, name, optional reference, parent_id, and can include departments, features, stats, and addresses.
  • Group — Collaboration spaces. Have name, type (public/private), optional description. Users are members or admins.
  • Content — Posts in feeds (news, debate, event). Include title, body, publish/visibility, comments, files, polls, and event data.
  • Conversation — Direct or group chats. Have participants, optional title, latest message, and unread state. Message is a single message in a conversation (text, author, reactions, attachments).
  • User types — Roles with optional permissions (abilities). Users are assigned one or more user types per unit.
  • Alerts — Active alerts with id, message, type (info/warning/danger), and optional rich content.
  • Counters — Simple counts such as unread notifications and unread conversations (plus a timestamp).