Account and Settings

← Back to Documentation Index

This page covers account management, team members, invitations, user settings, and API keys.


Account Overview

Navigate to Account from the user menu in the top header (click your account name, then select Account). All members can view the account overview; management actions depend on your role.

The account overview page shows:

  • Account name — Your organization or account name
  • Account tier — Your subscription tier (Hobby, Professional, or Enterprise)
  • Your role — Your role within this account (owner, admin, contributor, or reader)
  • Seat usage — A progress bar showing how many seats are used out of the total available
  • Member count — Total members in the account

Account Roles

RolePermissions
OwnerFull control — manage members, delete account, access all data
AdminManage members (non-owners), access all data
ContributorCreate, edit, and delete their own data; view all data in the account
ReaderView data only — cannot create, edit, or delete

Your role is displayed as a colored badge on the account overview page.


Multi-Account Support

If you belong to multiple accounts, you can switch between them using the Account Switcher in the top header.

  1. Click your current account name in the header.
  2. A dropdown shows all accounts you belong to.
  3. Click an account to switch to it.
  4. The application reloads with that account's data.

Each account is fully isolated — switching accounts changes which timelines, events, entities, and sources you see.


Managing Members

Available to: Owner, Admin

Viewing Members

  1. Go to Account > Members.
  2. You'll see a list of all members in the account.

Each member row shows:

  • Member name and email
  • Role badge (colored)
  • Contribution count
  • Remove button (for non-owner members)

Member Detail Page

Click any member to see their detail page:

  • Contributions Chart — A heatmap showing the member's activity over time (created/updated objects)
  • Role — Current role with the ability to change it (owner/admin only)
  • Remove button — Remove the member from the account

Changing a Member's Role

  1. On the member detail page, use the role dropdown.
  2. Select a new role.
  3. The change takes effect immediately.

You cannot change the owner's role. There must always be at least one owner.

Removing a Member

  1. On the member detail page, click Remove.
  2. Confirm in the dialog.
  3. The member loses access to the account. Their data remains in the account.

Invitations

Available to: Owner, Admin

Creating an Invitation

  1. Go to Account > Invitations.
  2. Click + New Invitation.
  3. Fill in:

- Email — The recipient's email address
- Role — The role they will have in the account

  1. Click Send.

The recipient receives an email with a registration link. When they register, they are automatically added to your account with the assigned role.

Managing Invitations

The invitations list shows:

  • Email — Recipient address
  • Role — Assigned role
  • Statuspending, accepted, or expired
  • Created — When the invitation was sent

Actions available:

  • Resend — Send the invitation email again (for pending invitations)
  • Revoke — Cancel the invitation (for pending invitations)

Accepted invitations cannot be revoked, and the member must be removed via the Members page instead.


Developer API

The Developer API page is accessible from the left sidebar via Developer API. This page provides MCP (Model Context Protocol) configuration, HTTP API documentation, and the Scalar API Reference explorer.

API access is a tier-gated feature. Your subscription tier determines what you see on this page.

Tier-Based Access

TierMCP Config BoxScalar API Reference"Roll Your Own MCP" Guide
EnterpriseYesYesNo
ProfessionalNoYesYes
HobbyNoNoNo

Enterprise Tier

Full API and MCP access. The page displays:

  • MCP Client Configuration — A JSON config block you can paste into your MCP client (Claude Desktop, Cursor, etc.) to connect to the edge server's SSE endpoint. Includes a copy button.
  • HTTP API — The full Scalar API Reference explorer showing all available REST endpoints for managing timelines, events, entities, claims, sources, and more.
  • How It Works / Why It Matters — Info cards explaining the MCP SSE transport and the benefits of structured timelines for AI assistants.

Professional Tier

API access with a self-service MCP path. The page displays:

  • Roll Your Own MCP Server — A guide showing the API endpoint URL, the MCP SSE path, and instructions for building your own lightweight MCP server wrapper around the REST API.
  • HTTP API — The full Scalar API Reference explorer (same as Enterprise).
  • How It Works / Why It Matters — The same MCP concept cards.

Hobby Tier

No API or MCP access. The page displays an upgrade prompt:

  • A message explaining that API access requires upgrading.
  • An Upgrade to Professional button that initiates a Stripe checkout session.

After upgrading, your account tier is updated and you can immediately access the Developer API page with Professional-tier features.

Upgrading Your Tier

To upgrade from Hobby to Professional or from Professional to Enterprise:

  1. Navigate to Account > Subscription (accessible from Account Management).
  2. Click the Upgrade button on the desired tier card.
  3. You will be redirected to Stripe's hosted checkout page to complete payment.
  4. After a successful checkout, your tier is upgraded and new features are available immediately.

Alternatively, if you are on the Hobby tier and visit /api-reference, the upgrade prompt on that page provides a direct Upgrade to Professional button.


Settings

Navigate to Settings from the user menu in the top header (click your account name, then select Settings).

Profile

The Profile tab lets you manage your personal account settings:

SettingDescription
Display NameVisible to other members of your account. Not your login identifier.
EmailYour email address. Used for login and notifications.
Change PasswordUpdate your password. Requires current password + new password + confirmation.

Click Save to apply profile changes.

API Keys

The API Keys tab lets you manage API keys for programmatic access.

API keys are per-account. Each key is scoped to the account you are currently viewing.

Creating an API Key:

  1. Click + New API Key.
  2. Give the key a descriptive name (e.g., "Newsroom Integration" or "Extraction Pipeline").
  3. Click Create.
  4. The key is generated and displayed once. Copy it immediately — it cannot be shown again.

Managing API Keys:

Each key shows:

  • Name — The descriptive name you gave it
  • Created — When the key was generated
  • Last Used — When the key was last used to authenticate
  • Revoke button — Immediately invalidates the key. Cannot be undone.

Security: Treat API keys like passwords. Never commit them to version control. Revoke keys that are no longer needed or that may have been compromised.

Accounts

The Accounts tab lists all accounts you belong to:

  • Account name and your role in each
  • Leave button — Remove yourself from an account

You cannot leave an account if you are the only remaining owner. Assign another owner first.


Account Deactivation

From the Settings > Profile tab, you can deactivate your account. This:

  • Removes you from all accounts you belong to
  • Disables your login
  • Preserves your contributed data (events, claims, etc.) in the accounts
  • Cannot be undone without administrator intervention

Warning: Deactivation is permanent from your perspective. Contact your system administrator if you need to reactivate.


Type Management

Available via Type Management in the sidebar (Tools section), or at /app/account/types. Visible to all roles, but only Owner and Admin can create or edit types.

This page lets you manage the custom type taxonomies for your account. You can create, edit, hide, and unhide types for:

  • Event types — Custom event classifications
  • Source types — Custom source categories
  • Entity types — Custom entity classifications
  • Relationship types — Custom relationship categories

Each type has:

  • Name — Display name
  • Description — What the type means
  • Color — Visual color for badges and icons
  • Icon — Lucide icon for visual identification

Types can be hidden (soft-deleted) and unhidden. Hidden types don't appear in type dropdowns but are preserved for historical data.


← Back to Documentation Index