Pulse Connect — Keys & Tier Access

Jessica

Jessica

Last updated on Aug 18, 2026

Pulse Connect is the platform's external API: clients and firms mint API keys to use Pulse data in their own tools (AI assistants, dashboards) against the Data API and MCP server. This page is the platform team's control center for it: every key across every tenant, plus the tier list that decides who can use Connect at all.

💡 Tip — Who can use this Platform administrators only. End-user key management lives in the client Settings and firm Settings portals (see the client and firm help articles).

Quick reference

Step Action
1 Open the Connect API Keys page
2 Review keys across all tenants
3 Revoke a key
4 Edit the Allowed Tiers list

Step 1: Open the Connect API Keys page

In the admin portal, click Connect Keys in the sidebar menu (under Pricing). It shows the total key count and everything below.

Pulse Connect admin overview

Step 2: Review keys across all tenants

The table lists every API key on the platform: masked prefix, tenant (organization or firm, with an ORG/FIRM badge and name), status, last-used time, and creation date. Revoked keys remain listed for audit. "Last used" stamps update as keys are exercised — a key marked ACTIVE that has never been used is a candidate for cleanup with its owner.

All keys table

Step 3: Revoke a key

Each active key has a Revoke button. Use it for support requests ("kill my leaked key"), offboarding, or housekeeping. Revocation takes effect on the key's next request — no deploy or restart needed.

📝 Note — There is a platform kill switch If Pulse Connect ever needs to be switched off entirely (incident response, maintenance), setting the environment variable CONNECT_ENABLED=false and redeploying disables both the API and MCP endpoints platform-wide (503 responses), hides the client UI, and blocks new key creation — without touching any keys.

Step 4: Edit the Allowed Tiers list

The Allowed Tiers field is a comma-separated list of client tiers that may use Pulse Connect with organization keys (default: executive,partner). Changes apply at request time — a tier removed from the list loses API access on its very next call, and a tier added gains it immediately. Editing requires a save reason, like the pricing page.

Allowed tiers editor

⚠️ Warning — Firm keys are not governed by this list The tier list applies to organization (client) keys only. Firm keys are governed by firm suspension instead — a suspended firm's keys are blocked automatically. Also note client keys stop working on their own when the client's account becomes inactive (expired plan, suspended firm, or deactivation), mirroring the portal's lockout rules.

📝 Note — Trial accounts Trial-tier organizations are excluded by default. If you add trial to the list, remember trials still expire by their own subscription rules — Connect access follows automatically.