# GainTrace

> GainTrace API documentation

## Docs

- [Create or update a company](https://docs.gaintrace.com/api-reference/companies/create-or-update-a-company.md): Creates a company, or updates the existing one with the same `externalId` (upsert).
- [Get a company](https://docs.gaintrace.com/api-reference/companies/get-a-company.md): Fetch one company by UUID or `ext:<externalId>`.
- [List companies](https://docs.gaintrace.com/api-reference/companies/list-companies.md): Returns the workspace's companies, most-recently-updated first.
- [Update a company](https://docs.gaintrace.com/api-reference/companies/update-a-company.md): Update mutable fields on an existing company.
- [Create a contact](https://docs.gaintrace.com/api-reference/contacts/create-a-contact.md): Create a contact under an account. Email is unique per workspace (409 on conflict).
- [Delete a contact](https://docs.gaintrace.com/api-reference/contacts/delete-a-contact.md): Permanently delete a contact.
- [Get a contact](https://docs.gaintrace.com/api-reference/contacts/get-a-contact.md): Fetch one contact.
- [List contacts](https://docs.gaintrace.com/api-reference/contacts/list-contacts.md): List contacts, optionally scoped to one account or email.
- [Update a contact](https://docs.gaintrace.com/api-reference/contacts/update-a-contact.md): Update mutable contact fields.
- [Ingest metric events](https://docs.gaintrace.com/api-reference/ingest/ingest-metric-events.md): Ingests a batch of typed metric events into the metrics engine (feeds daily snapshots that calc metrics evaluate). Idempotent on `(source, externalId)`; duplicates are skipped silently. Returns a per-event outcome.
- [Ingest product events](https://docs.gaintrace.com/api-reference/ingest/ingest-product-events.md): Ingests a batch of product-usage events (Segment-style). Feeds health, signals, and activation recompute.
- [Create a signal](https://docs.gaintrace.com/api-reference/signals/create-a-signal.md): Records a signal against a company in the workspace.
- [Create signals in bulk](https://docs.gaintrace.com/api-reference/signals/create-signals-in-bulk.md): Create up to 1000 signals. Partial success: each item reports its own outcome.
- [Dismiss a signal](https://docs.gaintrace.com/api-reference/signals/dismiss-a-signal.md): Soft-deletes (dismisses) the signal.
- [Get a signal](https://docs.gaintrace.com/api-reference/signals/get-a-signal.md): Fetch one signal by id.
- [List signals](https://docs.gaintrace.com/api-reference/signals/list-signals.md): Returns non-dismissed signals for the workspace, most-recent first.
- [Update a signal](https://docs.gaintrace.com/api-reference/signals/update-a-signal.md): Update a signal's title, description, severity, snooze, or metadata.
- [Create a webhook](https://docs.gaintrace.com/api-reference/webhooks/create-a-webhook.md): Register a webhook subscription. The signing `secret` is returned only in this response.
- [Delete a webhook](https://docs.gaintrace.com/api-reference/webhooks/delete-a-webhook.md): Delete a webhook and its delivery history.
- [Get a webhook](https://docs.gaintrace.com/api-reference/webhooks/get-a-webhook.md): Fetch one webhook.
- [List webhooks](https://docs.gaintrace.com/api-reference/webhooks/list-webhooks.md): List the workspace's webhook subscriptions.
- [Send a test event](https://docs.gaintrace.com/api-reference/webhooks/send-a-test-event.md): Send a signed `ping` to the endpoint now and return the result.
- [Update a webhook](https://docs.gaintrace.com/api-reference/webhooks/update-a-webhook.md): Update url, events, headers, description, or active state.
- [Authentication](https://docs.gaintrace.com/authentication.md): Authenticate with a Bearer API key, scoped to a workspace.
- [How health works](https://docs.gaintrace.com/help/accounts/health.md): What a company's health means and where you'll see it.
- [Triage](https://docs.gaintrace.com/help/accounts/triage.md): Work the queue of AI-drafted actions and coverage gaps that need your attention.
- [Billing and plans](https://docs.gaintrace.com/help/admin/billing.md): See your plan and usage, change plans, and manage your subscription.
- [Governance](https://docs.gaintrace.com/help/admin/governance.md): Audit trail, data retention, field access, and IP controls for your workspace.
- [Members and roles](https://docs.gaintrace.com/help/admin/members.md): Invite your team, set what each person can do, and manage who's in the workspace.
- [Flows](https://docs.gaintrace.com/help/automation/flows.md): Automate the repetitive parts of customer success without writing code.
- [Boards](https://docs.gaintrace.com/help/boards/boards.md): Build dashboards from chart widgets over your real customer data.
- [Setting up your workspace](https://docs.gaintrace.com/help/getting-started/for-admins.md): For admins: connect your data, invite your team, and get health scores flowing.
- [Your day in GainTrace](https://docs.gaintrace.com/help/getting-started/for-csms.md): For CSMs: triage your accounts, dig into a company, and stay ahead of renewals.
- [What GainTrace does](https://docs.gaintrace.com/help/getting-started/what-is-gaintrace.md): A plain-language tour of the product and the ideas behind it.
- [Welcome](https://docs.gaintrace.com/help/index.md): Guides for getting set up and running customer success on GainTrace.
- [Connect Attio to GainTrace](https://docs.gaintrace.com/help/integrations/attio.md): Sync Attio companies, people, and deals into GainTrace to power health scores, signals, and renewals. Set up the Attio integration in a few minutes.
- [Connect Gong to GainTrace](https://docs.gaintrace.com/help/integrations/gong.md): Sync Gong calls and conversation data into GainTrace so what customers say on calls feeds signals and account context. Set up the Gong integration in minutes.
- [Connect HubSpot to GainTrace](https://docs.gaintrace.com/help/integrations/hubspot.md): Sync HubSpot contacts, companies, and deals into GainTrace to power health scores, signals, and renewals. Set up the HubSpot integration in a few minutes.
- [Integrations](https://docs.gaintrace.com/help/integrations/integrations.md): Connect the tools you already use so GainTrace has the full picture of each customer.
- [Connect Intercom to GainTrace](https://docs.gaintrace.com/help/integrations/intercom.md): Sync Intercom contacts, companies, and conversations into GainTrace so support activity feeds health scores and signals. Connect the Intercom integration in minutes.
- [Connect Mixpanel to GainTrace](https://docs.gaintrace.com/help/integrations/mixpanel.md): Sync Mixpanel events and user profiles into GainTrace so product usage drives health scores, activation, and signals. Set up the Mixpanel integration in minutes.
- [Connect PostHog to GainTrace](https://docs.gaintrace.com/help/integrations/posthog.md): Sync PostHog product events and users into GainTrace so real usage drives health scores, activation, and signals. Set up the PostHog integration in minutes.
- [Connect Salesforce to GainTrace](https://docs.gaintrace.com/help/integrations/salesforce.md): Sync Salesforce accounts, contacts, and opportunities into GainTrace to drive health scores, signals, and renewals. Connect the Salesforce integration in minutes.
- [Connect Slack to GainTrace](https://docs.gaintrace.com/help/integrations/slack.md): Connect Slack to GainTrace to bring channel activity into your workspace. Set up the Slack integration in a few minutes.
- [Connect Stripe to GainTrace](https://docs.gaintrace.com/help/integrations/stripe.md): Sync Stripe customers, subscriptions, and invoices into GainTrace so revenue and billing signals feed health scores and renewals. Set up the Stripe integration in minutes.
- [Companies](https://docs.gaintrace.com/help/records/companies.md): Browse your accounts, filter by health, assign owners, and open any company's full record.
- [People](https://docs.gaintrace.com/help/records/people.md): Find the contacts at your accounts, see who's engaged, and track your champions.
- [Revenue](https://docs.gaintrace.com/help/records/revenue.md): Lay your companies out by pipeline stage and watch ARR add up per column.
- [Success plans](https://docs.gaintrace.com/help/success/success-plans.md): Set goals and outcomes for your key accounts, track progress, and run a QBR.
- [Trace AI](https://docs.gaintrace.com/help/trace-ai/trace-ai.md): Ask questions about your accounts and let Trace AI draft the follow-up.
- [Introduction](https://docs.gaintrace.com/index.md): The GainTrace REST API — read your customer data and push usage events and signals.
- [MCP server](https://docs.gaintrace.com/mcp-server.md): Connect Claude, Cursor, and any MCP client to your GainTrace workspace.
- [Quickstart](https://docs.gaintrace.com/quickstart.md): Make your first GainTrace API call in a couple of minutes.
- [Webhooks](https://docs.gaintrace.com/webhooks.md): Subscribe to workspace events with signed, retried delivery.

## OpenAPI Specs

- [openapi](https://docs.gaintrace.com/openapi.json)