Skip to main content

Team API Overview

The Informer Team API provides comprehensive endpoints for managing teams, their members, and team-specific resources including AI seats and subscriptions. All routes are prefixed with /api.

Features

  • CRUD Operations - Create, read, update, and delete teams
  • Member Management - Add, remove, and manage team members with roles
  • Memberships - Bulk membership operations
  • Activity Feed - Team activity notifications
  • Comments - Team discussions
  • AI Seats - Manage AI feature access for team members
  • AI Subscriptions - Purchase and manage AI subscriptions
  • Payment Methods - Manage team payment cards

Team Structure

A team consists of:

ComponentDescription
idUnique team identifier (prefixed with team:)
nameTeam display name
descriptionTeam description
iconCustom icon/logo
materialIconMaterial icon name
colorTeam color (hex)
settingsTeam preferences (JSONB)
createdAtCreation timestamp

Team Roles

Members can have different roles:

RolePermissions
adminFull team management and content control
publisherPublish and share content
dataWizardCreate and manage data resources
designerDesign reports and visuals
memberPlusExtended viewing capabilities
memberBasic viewing and collaboration

Authentication

All Team API endpoints require authentication via session cookies or API tokens.

Common Permission Patterns

  • Create teams - teams:create permission
  • Edit team - Team admin or superuser
  • Manage members - Team admin
  • View team - Team membership or shared content access

Next Steps

Explore the specific endpoint categories: