Command reference

Most commands in this reference share these common flags:

Flag	Description
`--api-key <key>`	Override the active API key for this request
`--json`	Force JSON output (auto-enabled when piped)
`--help`	Show help for the command

Activation

Inspect, preview against past events, and explicitly configure the exact ordinary product event Outlit uses for activation. The first matching event activates eligible contacts and their resolved company. Outlit records activation for each eligible person and resolved company only once. Later matching events leave those timestamps unchanged. Applications and connected analytics sources keep sending ordinary product events. They do not send a synthetic activation event or change lifecycle state directly.

Get

outlit activation get --json

The command returns the configured eventName.

Preview

Preview one exact event name against historical product events:

outlit activation preview \
  --event integration_connected \
  --lookback-days 30 \
  --example-limit 10 \
  --json

Preview is always read-only. It never saves the event setting, changes activatedAt, or records activation. The response reports separate contact and company totals: matching people and companies, those already activated, and those that would activate if this event were configured. evaluatedContactOccurrenceCount counts matching contact-event occurrences, while evaluatedEventCount counts matching events attributed to resolved companies. Contact identities are not returned as preview examples. Both sides are bounded independently for query safety. If contactTruncated is true, treat contact totals as lower bounds. If customerTruncated is true, treat company totals as lower bounds. The legacy truncated flag can also mean that exampleLimit omitted company examples, so it does not by itself make aggregate totals a lower bound.

Flag	Required	Description
`--event`	Yes	Exact ordinary product event name, from 1–191 characters
`--lookback-days`	No	Historical lookback from 1–90 (server default: 30)
`--example-limit`	No	Customer examples from 1–20 (server default: 10)

Update

After reviewing a preview, explicitly replace the configured event name:

outlit activation update \
  --event integration_connected \
  --json

Saving the event name changes future matching only. It does not scan historical events or backfill activation.

Disable

To stop future activation matching:

outlit activation disable --json

Disabling preserves existing contact and company activation timestamps. All four commands return the public tool result in --json and piped output. Local validation errors use the CLI’s missing_input or invalid_input shape; gateway failures retain Outlit’s stable code, message, retryable, and requestId envelope.

Customers list

List and filter customers with pagination.

outlit customers list [flags]

Flags

Flag	Type	Default	Description
`--billing-status`	string	—	Filter by billing status: `NONE`, `TRIALING`, `PAYING`, `PAST_DUE`, `CHURNED`
`--mrr-above`	number	—	MRR floor, in `currentMrr`’s units: cents for USD, EUR, GBP, and CAD (e.g. `10000` for $100/mo in USD)
`--mrr-below`	number	—	MRR ceiling, in the same units as `--mrr-above`
`--no-activity-in`	string	—	Inactive for period: `7d`, `14d`, `30d`, `90d`
`--has-activity-in`	string	—	Active within period: `7d`, `14d`, `30d`, `90d`
`--trait`	string	—	Exact trait filters as comma-separated `key=value` pairs (for example `segment=enterprise,active=true`)
`--activated-since`	string	—	Company activation at or after an ISO-8601 datetime; explicit offsets are accepted
`--search`	string	—	Search by name or domain
`--order-by`	string	`last_activity_at`	Sort field
`--order-direction`	string	`desc`	Sort direction: `asc`, `desc`
`--limit`	number	`20`	Results per page (1–100)
`--cursor`	string	—	Pagination cursor from a previous response

Examples

# Paying customers inactive for 30 days
outlit customers list --billing-status PAYING --no-activity-in 30d

# High-MRR customers sorted by revenue
outlit customers list --mrr-above 50000 --order-by mrr_cents --order-direction desc

# Search for a customer
outlit customers list --search "acme"

# Filter by exact customer traits
outlit customers list --trait "segment=enterprise,active=true"

# Companies activated since July 1
outlit customers list --activated-since 2026-07-01T00:00:00Z

# Pipe to jq
outlit customers list --json | jq '.items[] | {domain, activatedAt}'

JSON response

{
  "items": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Acme Corp",
      "domain": "acme.com",
      "billingStatus": "PAYING",
      "currentMrr": 500000,
      "mrrCalculationStatus": "calculated",
      "contactCount": 42,
      "firstSeenAt": "2025-01-02T10:00:00Z",
      "lastActivityAt": "2025-02-10T15:30:00Z",
      "activatedAt": "2025-01-20T09:15:00Z",
      "owner": null,
      "daysSinceActivity": 3
    }
  ],
  "pagination": {
    "hasMore": true,
    "nextCursor": "cursor_abc123",
    "total": 150
  }
}

currentMrr is an integer in the billing provider’s units for the customer’s currency, which the response doesn’t name. For USD, EUR, GBP, and CAD this is cents: 500000 is $5,000 MRR for a customer billed in USD. Other currencies follow the provider’s amount rules (see Stripe’s currency docs). ARR is 12 × currentMrr in the same units. currentMrr is null unless mrrCalculationStatus is calculated.

Pagination

Use --cursor to page through results:

# First page
outlit customers list --limit 50 --json > page1.json

# Next page
CURSOR=$(jq -r '.pagination.nextCursor' page1.json)
outlit customers list --limit 50 --cursor "$CURSOR" --json

In interactive mode, the CLI shows a hint after the table:

Showing 20 of 150 total. Next page: --cursor cursor_abc123

Customers get

Get a detailed customer profile with optional sections.

outlit customers get <customer> [flags]

Arguments

Argument	Required	Description
`customer`	Yes	Customer domain (e.g. `acme.com`), UUID, or name

Flags

Flag	Type	Default	Description
`--include`	string	—	Comma-separated sections: `users`, `revenue`, `recentTimeline`, `behaviorMetrics`, `enrichment`
`--timeframe`	string	`30d`	Lookback window for included sections: `7d`, `14d`, `30d`, `90d`

Examples

# Basic profile
outlit customers get acme.com

# Profile with people, revenue, and recent activity
outlit customers get acme.com --include users,revenue,recentTimeline --timeframe 90d

# By UUID
outlit customers get 550e8400-e29b-41d4-a716-446655440000

JSON response

{
  "customer": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Acme Corp",
    "domain": "acme.com",
    "billingStatus": "PAYING",
    "activatedAt": "2025-01-20T09:15:00Z",
    "firstSeenAt": "2025-01-02T10:00:00Z",
    "lastActivityAt": "2025-02-10T15:30:00Z",
    "owner": null
  },
  "users": [
    {
      "id": "user-uuid",
      "name": "Jane Doe",
      "email": "jane@acme.com",
      "journeyStage": "ENGAGED",
      "lastActivityAt": "2025-02-10T15:30:00Z",
      "relationshipRole": "Champion",
      "jobTitle": "VP of Product",
      "department": "Product",
      "employmentStartDate": "2023-04-10",
      "sources": [
        {
          "system": "hubspot",
          "kind": "contact",
          "count": null,
          "firstSeenAt": "2024-11-04T16:15:01.000Z",
          "lastSeenAt": null
        },
        {
          "system": "gong",
          "kind": "call",
          "count": 4,
          "firstSeenAt": "2025-01-06T17:00:00.000Z",
          "lastSeenAt": "2025-02-10T15:30:00.000Z"
        }
      ]
    }
  ],
  "revenue": {
    "currentMrr": 500000,
    "mrrCalculationStatus": "calculated",
    "lifetimeRevenue": 2400000,
    "activeSubscriptions": 1
  },
  "recentTimeline": [
    {
      "type": "PAGE_VIEW",
      "title": "Pricing page viewed",
      "contact": "jane@acme.com",
      "occurredAt": "2025-02-10T15:30:00Z"
    }
  ]
}

revenue.currentMrr and revenue.lifetimeRevenue are in the billing provider’s units, like currentMrr in customers list: for a customer billed in USD, 500000 is

5,000 MRR and `2400000` is

24,000 of lifetime revenue.

customer.activatedAt is an ISO-8601 timestamp when Outlit has recorded company activation, and null otherwise. Contact journey stages remain separate under users.

Customers relationship

Get the relationship summary used for customer detail, without adding it to the customers get response or replacing the chronological activity timeline.

outlit customers relationship <customer>

<customer> accepts a customer domain, UUID, or exact name. The relationship returns the stable customer identity and a bounded relationship section (summary plus up to eight categorized current statements). Each statement carries an ISO observedAt timestamp when the authorized source supports one and bounded sourceLabels. updatedAt is the compiled summary timestamp when available, and otherwise null. The response never includes raw quotes, internal memory-card data, unrestricted fact IDs, or unbounded source records.

outlit customers relationship acme.com --json

JSON response

{
  "customer": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Acme Corp",
    "domain": "acme.com"
  },
  "relationship": {
    "summary": "Renewal needs attention",
    "items": [
      {
        "category": "Renewal",
        "statement": "The renewal is under active review.",
        "observedAt": "2026-08-01T10:30:00.000Z",
        "sourceLabels": ["CRM opportunity"]
      }
    ],
    "updatedAt": "2026-08-13T00:00:00.000Z"
  }
}

Customer identity and merging

Inspect a customer’s identity coverage and possible split records using its exact customer ID:

outlit customers identity "<customerId>" --json

Candidate records are leads, not proof of common identity. An empty or incomplete search does not prove the account has zero usage. This read never creates a merge suggestion or combines customer activity. Saved suggestions and review history are a separate read. List returns complete details; use --suggestion-id to retrieve one exact record in the same collection response, or --customer-id to scope the list. Follow nextCursor using --cursor.

outlit identity suggestions list --customer-id "<customerId>" --limit 20 --json
outlit identity suggestions list --suggestion-id "<suggestionId>" --json
outlit identity suggestions reject "<suggestionId>" --review-notes "Different companies" --json

List also accepts --status suggested|processing|merged|rejected and --confidence HIGH|MEDIUM|LOW. Rejection requires identity review authority and does not authorize merging. It returns only { "suggestionId": "…", "status": "REJECTED" }; read the suggestion list again for updated details. The merge command previews by default. Both positional arguments are exact IDs; the first is the surviving record. Without --suggestion-id, both records must be COMPANY customers. A pair involving an INDIVIDUAL requires an eligible saved suggestion for that exact pair. An optional --suggestion-id links an existing suggestion to the exact pair, and --review-notes records the review explanation.

outlit customers merge "<survivorId>" "<duplicateId>" --json

Merge execution is dangerous and has no supported undo. It moves customer data and access relationships into the survivor. Execute only when authorized and certain that the records represent the same customer; two company records must represent the same company. Similar names, related domains, shared participants, and parent/subsidiary relationships do not establish that identity. If uncertain, do not execute.

Execution requires an explicit --execute, the reviewed preview’s token, a stable request ID, and dedicated merge authority. A read-only credential can preview but cannot execute. A merge API key must include an explicitly selected customer_identity:merge grant; ordinary full-access and personal CLI presets exclude it. Use the same pair, token, request ID, and review inputs when retrying an execution.

outlit customers merge "<survivorId>" "<duplicateId>" --execute --preview-token "<token>" --request-id "<stableId>" --json
outlit customers merge-status "<operationId>" --json

A saved suggestion’s latestJob.operationId, when present, can be passed to customers merge-status. A null value means that job has no public operation ID attached. A queued or running merge has not finished. Reading status does not run the merge again, including after a partial failure. The workspace must support these commands, and the API key needs the required permission.

Customers credits

Read imported credit pools and burn summaries for one authorized customer.

outlit customers credits <customer>

<customer> accepts a customer domain, UUID, or exact name. The command returns the same JSON schema as outlit_get_customer_credits: the resolved customer, overall availability status, credit pools, and a truncated marker. Each credit pool keeps its provider source, observation time, staleness, granted and remaining amounts, reset date, and burn summary. Missing or stale provider observations remain distinct from a zero balance.

outlit customers credits acme.com --json

Customers features

Read event-based and imported metered Feature usage for one authorized customer.

outlit customers features <customer> [--weeks 1-53] [--weekly]

<customer> accepts a customer domain, UUID, or exact name. The default window is 12 weeks. The response is a flat features array. Every item has a kind discriminator. An event item reports historical evidence from its configured Outlit event rule. A metered item reports provider-defined quantities imported from Autumn and may link to an event Feature. These values use different units and must not be added together. The response also lists source status so a missing provider connection, unavailable source, and an available source with no matches remain distinct. Top-level events is available or unavailable; if the event source cannot be read, imported metered Features can still be returned. Complete, partial, and unavailable evidence remain distinct; unavailable evidence is never rendered as zero usage. Add --weekly to include ordered weekly buckets. Event Features report eventCount and activeDays. Metered Features report their provider quantity and observed days.

outlit customers features acme.com --json
outlit customers features acme.com --weeks 6 --json
outlit customers features acme.com --weeks 53 --weekly --json

Features

Configure the small workspace taxonomy of product capabilities whose recurring use represents customer value.

outlit features list [flags]
outlit features create [flags]
outlit features archive <id> --revision <revision>

features list returns eligible product-event sources, the selected source, active features with exact historical evidence, and candidate discovery. Candidate discovery is a discriminated result: ready and partial contain items and truncated, while unavailable contains a reason. Outlit auto-selects a source only when exactly one is eligible.

Workspace flag	Default	Description
`--source`	auto-select when unambiguous	Exact source key returned by the workspace command
`--weeks`	`12`	Historical evidence window from 1 to 53 weeks
`--candidate-limit`	`100`	Maximum event candidates from 1 to 100

Create one feature from one exact event rule:

outlit features create \
  --source metric_source_v1_0123456789abcdef0123456789abcdef \
  --event report_exported \
  --key reports_exported \
  --name "Reports exported" \
  --json

Use --property-filters with a JSON array of generated exact or exists filter objects when the event alone is too broad. Event names are preserved exactly; use the candidate returned by the workspace command. Archive requires both opaque values returned by Outlit:

outlit features archive \
  value_feature_v1_0123456789abcdef0123456789abcdef \
  --revision value_feature_revision_v1_fedcba9876543210fedcba9876543210 \
  --json

Creating a Feature atomically creates its internal weekly event-count and active-days metrics. Those metrics are implementation details rather than separate CLI resources. Outlit rejects stale revisions and prevents archiving the final active Feature. Historical usage remains available. Archive is the available self-service lifecycle action.

Attention

Inspect the authorized, read-only Attention collection. Attention is separate from customer relationship and from the chronological customer timeline.

outlit attention list [flags]
outlit attention get <id> [flags]

attention list defaults to open items. It accepts optional --customer-id, --limit (1–100; server default 25), and an opaque --cursor returned with the same filters. Use --status resolved for resolved items. Each returned item includes its current priority; the command does not filter by priority.

outlit attention list --status resolved --customer-id 550e8400-e29b-41d4-a716-446655440000 --json
outlit attention get 550e8400-e29b-41d4-a716-446655440000 --json

List rows contain bounded customer identity, current priority, evidence count, lifecycle times, and account importance. Detail adds the current assessment, timeline, evidence summaries, and latest visible update. accountImportance.arrCents is calculated by Outlit as 12 × the stored monthly revenue; clients must not multiply it again. It is in the billing provider’s units for accountImportance.currency: cents for USD, EUR, GBP, and CAD (1200000 is $12,000 ARR in USD), and other currencies follow the provider’s amount rules. arrShareWithinCurrency and arrPercentileWithinCurrency compare only customers in the same currency; neither implies FX conversion or an all-currency organization total. Both responses may contain a current reviewable preparedActionUrl only. They never include action IDs, action lifecycle or execution state, email drafts, recipients, evidence IDs, source URLs, internal responsibility-agent configuration, or billing-recovery details. The commands are read-only: there is no resolve, reopen, send, or review operation.

JSON response

{
  "items": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "customer": {
        "id": "4ad7ee3b-a3ff-46a8-902b-2b8eae6be671",
        "name": "Acme Corp",
        "domain": "acme.com",
        "ownerName": "Ada Lovelace"
      },
      "title": "Reporting usage collapsed",
      "priority": "HIGH",
      "evidenceCount": 2,
      "lifecycle": {
        "status": "open",
        "customerVisibleAt": "2026-08-01T00:00:00.000Z",
        "resolvedAt": null,
        "reopenedAt": null,
        "createdAt": "2026-08-01T00:00:00.000Z",
        "updatedAt": "2026-08-02T00:00:00.000Z",
        "materialUpdateAt": null
      },
      "accountImportance": {
        "arrCents": 1200000,
        "currency": "USD",
        "arrShareWithinCurrency": 0.12,
        "arrPercentileWithinCurrency": 95,
        "segments": ["Enterprise"]
      },
      "preparedActionUrl": null
    }
  ],
  "pagination": {
    "hasMore": false,
    "nextCursor": null,
    "total": 1
  }
}

Customer ownership and access

Assign a primary owner or manage a workspace member’s explicit Viewer or Editor access. These write commands require exact IDs and never resolve customer names, domains, or user emails on your behalf. For API keys, workspace-member discovery and customer mutations are independent capabilities. outlit ws-users list requires workspace_members:read; setting an owner, granting or changing access, and revoking access require customer_access:manage. The complete discover-then-mutate flow needs both grants, while scripts and agents that already know exact IDs may use customer_access:manage alone. API keys are independent workspace principals and do not inherit their creator’s human permissions or customer access. Read only includes discovery but not mutation, Full workspace access includes both grants, and Custom includes only the grants you select; there is no separate customer-collaboration preset. First discover the customer UUID. Use JSON output because the interactive table is optimized for scanning rather than copying identifiers:

outlit customers list --search "acme" --json

Copy the exact items[].id for the intended customer. Then discover the target workspace user:

outlit ws-users list --search "alex@example.com" --json

Without --has-owned-customers, this command lists all active workspace members that resolve to local Outlit users, including members who own no customers. Use --has-owned-customers only when you intentionally want to restrict discovery to current owners. Copy the exact workspace-user items[].id as --target-user-id. Review multiple matches before writing; the ownership and access commands intentionally do not perform fuzzy name matching.

Set owner

outlit customers owner set \
  10000000-0000-4000-8000-000000000000 \
  --target-user-id user_123 \
  --json

The target must be an active workspace member. When ownership changes, the former owner keeps Editor access.

Grant or change access

outlit customers grant \
  10000000-0000-4000-8000-000000000000 \
  --target-user-id user_123 \
  --role VIEWER \
  --json

Run the same grant command again with the other role to change an existing collaborator between Viewer and Editor.

Revoke access

outlit customers revoke \
  10000000-0000-4000-8000-000000000000 \
  --target-user-id user_123 \
  --json

--role accepts only VIEWER or EDITOR; OWNER is represented by the separate primary-owner assignment. Malformed customer IDs, missing or oversized target-user IDs, and invalid roles fail locally without sending a request. Permission, conflict, and other gateway failures retain Outlit’s structured code, message, retryable, and requestId fields in JSON output.

Customers timeline

View the activity timeline for a customer, filtered by channel and event type.

outlit customers timeline <customer> [flags]

Arguments

Argument	Required	Description
`customer`	Yes	Customer domain or UUID

Flags

Flag	Type	Default	Description
`--timeframe`	string	`30d`	Lookback window: `7d`, `14d`, `30d`, `90d`, `all`
`--start-date`	string	—	Start datetime (ISO 8601, for example `2025-01-01T00:00:00Z`) — overrides `--timeframe`
`--end-date`	string	—	End datetime (ISO 8601, for example `2025-03-01T23:59:59.999Z`) — overrides `--timeframe`
`--channels`	string	—	Comma-separated canonical channels: `PRODUCT`, `COMMUNICATION`, `MEETING`, `CRM`, `BILLING`, `SUPPORT`, `IDENTITY`, `DOCUMENT`, `SYSTEM`
`--event-types`	string	—	Comma-separated types: `PAGE_VIEW`, `MEETING`, `SUPPORT_TICKET`, etc.
`--limit`	number	`20`	Results per page (1–100)
`--cursor`	string	—	Pagination cursor

When --start-date or --end-date is provided, --timeframe is ignored. The CLI also accepts and normalizes these legacy aliases: SDK → PRODUCT, EMAIL → COMMUNICATION, SLACK → COMMUNICATION, CALL → MEETING, CALENDAR → MEETING, and INTERNAL → SYSTEM.

Examples

# Last 30 days (default)
outlit customers timeline acme.com

# Last 90 days, communication and meeting activity
outlit customers timeline acme.com --timeframe 90d --channels COMMUNICATION,MEETING

# Custom date range
outlit customers timeline acme.com --start-date 2025-01-01T00:00:00Z --end-date 2025-03-01T23:59:59.999Z

# Page views and meetings only
outlit customers timeline acme.com --event-types PAGE_VIEW,MEETING --limit 50

JSON response

{
  "events": [
    {
      "id": "event-uuid",
      "eventType": "PAGE_VIEW",
      "eventName": "pricing_page_viewed",
      "channel": "PRODUCT",
      "title": "Pricing page viewed",
      "summary": "Jane viewed the pricing page",
      "occurredAt": "2025-02-10T15:30:00Z",
      "contact": "jane@acme.com",
      "sourceType": null,
      "sourceId": null,
      "metadata": {
        "url": "https://acme.com/pricing",
        "title": "Pricing Page"
      }
    }
  ],
  "pagination": {
    "hasMore": false,
    "nextCursor": null,
    "effectiveLimit": 20
  }
}

Older CLI and tool versions may omit pagination.effectiveLimit, per-event unreadable/unreadableReason, and the product weekly usage aggregate (channels:"PRODUCT"). Check for their presence before using them.

Users list

List and filter users across your customer base.

outlit users list [flags]

Flags

Flag	Type	Default	Description
`--journey-stage`	string	—	Filter by stage: `DISCOVERED`, `SIGNED_UP`, `ACTIVATED`, `ENGAGED`, `INACTIVE`
`--customer-id`	string	—	Filter to users of a specific customer (UUID)
`--no-activity-in`	string	—	Inactive for period: `7d`, `14d`, `30d`, `90d`
`--has-activity-in`	string	—	Active within period: `7d`, `14d`, `30d`, `90d`
`--trait`	string	—	Exact trait filters as comma-separated `key=value` pairs (for example `role=admin,onboarded=true`)
`--search`	string	—	Search by name or email
`--order-by`	string	`last_activity_at`	Sort field
`--order-direction`	string	`desc`	Sort direction: `asc`, `desc`
`--limit`	number	`20`	Results per page (1–100)
`--cursor`	string	—	Pagination cursor

Examples

# Find engaged users
outlit users list --journey-stage ENGAGED

# Inactive users from a specific customer
outlit users list --customer-id 550e8400-... --no-activity-in 30d

# Filter by exact user traits
outlit users list --trait "role=admin,onboarded=true"

# Search by name
outlit users list --search "alice" --order-by last_activity_at

JSON response

{
  "items": [
    {
      "id": "user-uuid",
      "email": "jane@acme.com",
      "name": "Jane Doe",
      "customerId": "customer-uuid",
      "customerName": "Acme Corp",
      "customerDomain": "acme.com",
      "journeyStage": "ENGAGED",
      "lastActivityAt": "2025-02-10T15:30:00Z",
      "daysSinceActivity": 3,
      "relationshipRole": "Champion",
      "jobTitle": "VP of Product",
      "department": "Product",
      "employmentStartDate": "2023-04-10",
      "sources": [
        {
          "system": "hubspot",
          "kind": "contact",
          "count": null,
          "firstSeenAt": "2024-11-04T16:15:01.000Z",
          "lastSeenAt": null
        },
        {
          "system": "posthog",
          "kind": "product_user",
          "count": null,
          "firstSeenAt": "2025-01-20T09:15:00.000Z",
          "lastSeenAt": null
        }
      ]
    }
  ],
  "pagination": {
    "hasMore": true,
    "nextCursor": "cursor_abc",
    "total": 500
  }
}

Facts

Retrieve AI-generated facts and insights for a customer.

outlit facts list <customer> [flags]
outlit facts get --fact-id <id> [flags]

`facts list` arguments

Argument	Required	Description
`customer`	Yes	Customer domain or UUID

`facts list` flags

Flag	Type	Default	Description
`--status`	string	—	Comma-separated fact status filter: `ACTIVE`, `ACKNOWLEDGED`, `RESOLVED`, `SNOOZED`, `CANDIDATE`
`--source-types`	string	—	Comma-separated generic source type filter: `EMAIL`, `CALL`, `CALENDAR_EVENT`, `SUPPORT_TICKET`, `OPPORTUNITY`, `SLACK`, `PERSON_PROFILE`. Case-insensitive. Aliases: `CRM`, `CRM_OPPORTUNITY`
`--fact-types`	string	—	Comma-separated public fact type filter, including `CHURN_RISK`, `PRODUCT_USAGE`, `CONTACT_DEPARTURE`, `CONTACT_POSITION_CHANGE`, and `CONTACT_DISENGAGEMENT`
`--fact-categories`	string	—	Comma-separated fact category filter: `MEMORY`, `RELATIONSHIP`, `CUSTOM`
`--after`	string	—	Lower bound on fact occurrence time (ISO 8601 datetime)
`--before`	string	—	Upper bound on fact occurrence time (ISO 8601 datetime)
`--limit`	number	`20`	Results per page (1–100)
`--cursor`	string	—	Pagination cursor

`facts get` flags

Flag	Type	Default	Description
`--fact-id`	string	—	Exact fact identifier
`--include`	string	—	Comma-separated best-effort expansions. `evidence` requests evidence details when available

Examples

# All facts for a customer
outlit facts list acme.com

# Filter by status and source type
outlit facts list acme.com --status ACTIVE --source-types CALL,OPPORTUNITY --after 2025-01-01T00:00:00Z

# Filter customer-memory facts by public fact type
outlit facts list acme.com --fact-types CHURN_RISK,PRODUCT_USAGE

# Pipe for processing
outlit facts list acme.com --json | jq '.facts[] | select(.severity == "HIGH")'

# Fetch one exact fact with best-effort evidence expansion
outlit facts get --fact-id fact_123 --include evidence

JSON response

{
  "customer": {
    "id": "cust_123",
    "name": "Acme",
    "domain": "acme.com"
  },
  "facts": [
    {
      "id": "fact-uuid",
      "assertion": "Budget concerns raised",
      "reasoning": "The customer explicitly deferred the purchase because of budget timing.",
      "factType": "BUDGET",
      "factCategory": "MEMORY",
      "status": "ACTIVE",
      "confidence": 0.92,
      "priority": "HIGH",
      "severity": "HIGH",
      "occurredAt": "2025-02-10T14:00:00Z",
      "detectedAt": "2025-02-10T15:30:00Z",
      "validFrom": "2025-02-10T14:00:00Z",
      "validUntil": null,
      "linkedSourceRef": {
        "sourceType": "CALL",
        "sourceId": "call_123",
        "occurredAt": "2025-02-10T14:00:00Z",
        "permalink": "https://granola.ai/notes/call_123"
      },
      "sourceMetadata": {
        "sourceType": "CALL",
        "sourceId": "call_123",
        "sourceOccurredAt": "2025-02-10T14:00:00Z",
        "sourceQuote": "Budget is blocked until next quarter.",
        "permalink": "https://granola.ai/notes/call_123"
      },
      "evidenceCount": 1,
      "metricName": null,
      "metricValue": null,
      "metricPreviousValue": null,
      "metricDelta": null,
      "metricUnit": null,
      "periodStart": null,
      "periodEnd": null,
      "changePointDate": null,
      "occurrenceCount": 1,
      "lastDetectedAt": "2025-02-10T15:30:00Z"
    }
  ],
  "pagination": {
    "hasMore": false,
    "nextCursor": null
  }
}

facts get returns the same canonical fact shape as facts list. Passing --include evidence requests a best-effort evidence expansion; unsupported include values are ignored.

Search

Semantic search across customer context. Results are grouped at the artifact level, so matching sources and facts are returned directly instead of raw chunks.

outlit search <query> [flags]

Arguments

Argument	Required	Description
`query`	Yes	Natural language search query

Flags

Flag	Type	Default	Description
`--customer`	string	—	Scope to a specific customer (domain or UUID)
`--top-k`	number	`20`	Maximum results to return (1–50)
`--after`	string	—	Filter to events after this ISO 8601 datetime
`--before`	string	—	Filter to events before this ISO 8601 datetime
`--source-types`	string	—	Comma-separated generic source type filter (`EMAIL`, `CALL`, `CALENDAR_EVENT`, `SUPPORT_TICKET`, `OPPORTUNITY`, `SLACK`, `PERSON_PROFILE`). Case-insensitive. Aliases: `CRM`, `CRM_OPPORTUNITY`

Examples

# Organization-wide search
outlit search "pricing objections"

# Scoped to a customer
outlit search "budget concerns" --customer acme.com

# Time-bounded
outlit search "expansion opportunities" --after 2025-01-01T00:00:00Z --before 2025-03-31T23:59:59Z

# Filter by source type
outlit search "renewal opportunities" --source-types CALL,OPPORTUNITY

# More results (max 50)
outlit search "churn risk" --top-k 50 --json

JSON response

{
  "customer": {
    "id": "cust_123",
    "name": "Acme",
    "domain": "acme.com"
  },
  "results": [
    {
      "kind": "source",
      "score": 0.92,
      "matchCount": 2,
      "sourceType": "CALL",
      "sourceId": "call_456",
      "customer": {
        "id": "cust_123",
        "name": "Acme",
        "domain": "acme.com"
      },
      "occurredAt": "2025-02-10T15:30:00Z",
      "title": "Q1 planning meeting",
      "permalink": "https://granola.ai/notes/call_456",
      "matches": [
        {
          "text": "Customer mentioned pricing concerns in Q1 planning meeting"
        }
      ]
    }
  ]
}

Search returns both matching source and fact artifacts when both are relevant. Multiple chunk hits from the same source are grouped into one source result. The top-level customer is the --customer you scoped to, or null for an organization-wide search. Each result’s customer names the customer it belongs to, so an organization-wide search tells you whose call or fact matched. It is null when the result can’t be attributed to exactly one customer you can read, and older servers omit it; treat a missing customer like null.

Sources

List concrete source records deterministically or fetch one exact source by generic sourceType and sourceId.

List sources

List enumerated calls, emails, calendar events, support tickets, Slack conversations, or opportunities. Use this command when you need deterministic source records; use outlit search for semantic ranking. Results are paginated.

outlit sources list [flags]

Flags

Flag	Type	Default	Description
`--source-type`	string	—	Generic source type: `EMAIL`, `CALL`, `CALENDAR_EVENT`, `SUPPORT_TICKET`, `OPPORTUNITY`, `SLACK`, `PERSON_PROFILE`. Case-insensitive. Aliases: `CRM`, `CRM_OPPORTUNITY`
`--customer`	string	—	Customer UUID, domain, or name to scope source listing
`--participant`	string	—	Participant email or name to filter source records
`--provider`	string	—	Provider identifier such as `gmail`, `gong`, or `google-calendar`
`--has-transcript`	boolean	`false`	Only list call sources with a finalized transcript; when combined with `--source-type`, that type must be `CALL`
`--after`	string	—	Filter to sources occurring after this ISO 8601 UTC datetime
`--before`	string	—	Filter to sources occurring before this ISO 8601 UTC datetime
`--limit`	number	`50`	Results per page (1–100)
`--cursor`	string	—	Pagination cursor from a previous response (`pagination.nextCursor`)

Source-type aliases are normalized to their canonical values before the request. With --json, the command returns the paginated items and pagination response. In interactive output, rows show TYPE, OCCURRED, TITLE, and SOURCE ID; when more results are available, the next cursor is printed for the following --cursor request.

Examples

outlit sources list --customer acme.com --source-type CALL
outlit sources list --participant alice@acme.com --source-type CALENDAR_EVENT --json
outlit sources list --source-type SLACK --customer acme.com --limit 25 --json
outlit sources list --after 2026-01-01T00:00:00Z --limit 25

Get a source

outlit sources get --source-type <type> --source-id <id> [--limit <count>] [--cursor <cursor>]

Flags

Flag	Type	Default	Description
`--source-type`	string	—	Source type: `EMAIL`, `CALL`, `CALENDAR_EVENT`, `SUPPORT_TICKET`, `OPPORTUNITY`, `SLACK`, `PERSON_PROFILE`. Case-insensitive. Aliases: `CRM`, `CRM_OPPORTUNITY`
`--source-id`	string	—	Exact source identifier
`--limit`	number	`10`	Exact content segments per page (1–100).
`--cursor`	string	—	Opaque cursor returned by a previous exact lookup for the same source.

Examples

outlit sources get --source-type CALL --source-id call_123 --limit 10 --json
outlit sources get --source-type CALL --source-id call_123 --cursor "$CURSOR" --json
outlit sources get --source-type SLACK --source-id thread_123 --limit 50
outlit sources get --source-type SLACK --source-id thread_123 --cursor "$CURSOR"
outlit sources get --source-type OPPORTUNITY --source-id opp_123
outlit sources get --source-type SUPPORT_TICKET --source-id ticket_456 --json

EXTRACTED is accepted by the exact-source tool API but is currently rejected by outlit sources get. Use one of the source types listed above in the CLI. When a response includes contentPage, read contentPage.segments and check contentPage.completeness for partial or unavailable content. If contentPage.page.hasMore is true, pass contentPage.page.nextCursor as --cursor with the same source type and ID. Use --json to inspect these fields. When a fact or search result references a PERSON_PROFILE source, pass that source ID to exact lookup to inspect its evidence:

outlit sources get --source-type PERSON_PROFILE --source-id "$SOURCE_ID" --json

Destinations

Inspect and manage configured delivery destinations (for example Slack channels) with masked configuration only.

outlit destinations list [flags]
outlit destinations get <id> [flags]
outlit destinations create [flags]
outlit destinations update <id> [flags]
outlit destinations enable <id> [flags]
outlit destinations disable <id> [flags]
outlit destinations archive <id> [flags]

Examples

outlit destinations list --json
outlit destinations get 10000000-0000-4000-8000-000000000003 --json
outlit destinations create --type slack --channel-id C0123456789 --label "#customer-ops" --default --json
outlit destinations update 10000000-0000-4000-8000-000000000003 --type slack --default --json
outlit destinations enable 10000000-0000-4000-8000-000000000003 --json
outlit destinations disable 10000000-0000-4000-8000-000000000003 --json
outlit destinations archive 10000000-0000-4000-8000-000000000003 --json

Destination creation and update are Slack-channel backed. Use --default on destinations create or destinations update to make a destination the default fallback. destinations update patches only the fields you pass. Raw destination secrets and unmasked provider configuration are not returned.

Settings

Read and update the workspace timezone. Configure delivery and reports in the Outlit app.

outlit settings get [flags]
outlit settings update --default-timezone <iana-timezone> [flags]

Examples

outlit settings get --json
outlit settings update --default-timezone America/Los_Angeles --json
outlit destinations list --json

The public workspace settings capability returns and updates the default IANA timezone. Default delivery destination selection is handled by outlit destinations create --default or outlit destinations update --default.

SQL

Execute read-only SQL queries against Outlit analytics views.

outlit sql <query> [flags]
outlit sql --query-file <path> [flags]

Arguments

Argument	Required	Description
`query`	Yes*	SQL query string (*or use `--query-file`)

Flags

Flag	Type	Default	Description
`--query-file`	string	—	Path to a `.sql` file (takes precedence over positional arg)
`--limit`	number	`1000`	Maximum rows to return

Examples

# Inline query
outlit sql "SELECT event_type, COUNT(*) as cnt FROM activity GROUP BY 1 ORDER BY cnt DESC"

# From a file
outlit sql --query-file ./queries/monthly-activity.sql

# Pipe to jq
outlit sql "SELECT domain, mrr_cents FROM customers ORDER BY mrr_cents DESC LIMIT 10" | jq

JSON response

{
  "success": true,
  "data": [
    { "event_type": "PAGE_VIEW", "cnt": 12500 },
    { "event_type": "MEETING", "cnt": 340 }
  ],
  "metadata": {
    "rowsReturned": 2,
    "executionTimeMs": 18.4,
    "truncated": false
  }
}

Available views

Use outlit schema to discover all views and their columns. Common views:

View	Description
`activity`	Event stream (page views, meetings, emails, etc.)
`customers`	Denormalized customer attributes and metrics
`users`	Denormalized user attributes
`revenue`	Monthly recurring revenue snapshots

Schema

Discover analytics views and their column definitions.

outlit schema [view]

Arguments

Argument	Required	Description
`view`	No	Specific view name — omit to list all views

Examples

# List all views
outlit schema

# Describe a specific view
outlit schema activity

# JSON output
outlit schema customers --json

The public customers analytics view exposes company activation as activated_at Nullable(DateTime64(3)). Contact journey stages remain separate on users.

JSON response

{
  "name": "customers",
  "description": "One row per customer with current account and revenue attributes.",
  "columns": [
    {
      "name": "domain",
      "type": "Nullable(String)",
      "description": "Customer domain when known."
    },
    {
      "name": "mrr_cents",
      "type": "Nullable(Int64)",
      "description": "Current monthly recurring revenue in cents."
    }
  ],
  "exampleQueries": [
    "SELECT domain, mrr_cents FROM customers ORDER BY mrr_cents DESC LIMIT 10"
  ]
}

Feedback

Submit product feedback to the Outlit team: bug reports, feature ideas, or friction you hit while working with Outlit. Feedback is product intake — it is not a support ticket and does not guarantee a reply.

outlit feedback --body <text> [flags]

Flags

Flag	Type	Default	Description
`--body`	string	—	Feedback text (required unless `--body-file`); trimmed, non-empty, at most 20,000 characters
`--body-file`	string	—	Read the feedback body from a UTF-8 text file
`--area`	string	—	Optional product area label such as `cli`, `mcp`, or `integrations`; trimmed, non-empty, at most 100 characters
`--context`	string	—	Optional JSON object with diagnostic context; at most 16 KiB serialized
`--context-file`	string	—	Read the JSON context object from a file instead of `--context`

--body and --body-file are mutually exclusive, as are --context and --context-file. Use context for diagnostics such as the surface, command, or client version — never for secrets or unnecessary customer data. Submitting feedback requires an authenticated API key and is rate limited separately from customer-intelligence reads. It does not consume paid usage quota.

Examples

# Report a bug
outlit feedback --body 'The customers merge preview did not list the losing record traits' --area customers

# Suggest a feature
outlit feedback --body 'Add a way to export attention items' --area attention --json

# Include diagnostic context
outlit feedback \
  --body 'The SQL tool rejected a valid LIMIT clause' \
  --context '{"surface":"cli","command":"sql"}' \
  --json

# Long-form feedback from files
outlit feedback --body-file report.md --context-file diagnostics.json

JSON response

{
  "id": "10000000-0000-4000-8000-000000000004",
  "createdAt": "2026-09-28T12:00:00.000Z"
}

​Activation

​Get

​Preview

​Update

​Disable

​Customers list

​Flags

​Examples

​JSON response

​Pagination

​Customers get

​Arguments

​Flags

​Examples

​JSON response

​Customers relationship

​JSON response

​Customer identity and merging

​Customers credits

​Customers features

​Features

​Attention

​JSON response

​Customer ownership and access

​Set owner

​Grant or change access

​Revoke access

​Customers timeline

​Arguments

​Flags

​Examples

​JSON response

​Users list

​Flags

​Examples

​JSON response

​Facts

​facts list arguments

​facts list flags

​facts get flags

​Examples

​JSON response

​Search

​Arguments

​Flags

​Examples

​JSON response

​Sources

​List sources

​Flags

​Examples

​Get a source

​Flags

​Examples

​Destinations

​Examples

​Settings

​Examples

​SQL

​Arguments

​Flags

​Examples

​JSON response

​Available views

​Schema

​Arguments

​Examples

​JSON response

​Feedback

​Flags

​Examples

​JSON response

Activation

Get

Preview

Update

Disable

Customers list

Flags

Examples

JSON response

Pagination

Customers get

Arguments

Flags

Examples

JSON response

Customers relationship

JSON response

Customer identity and merging

Customers credits

Customers features

Features

Attention

JSON response

Customer ownership and access

Set owner

Grant or change access

Revoke access

Customers timeline

Arguments

Flags

Examples

JSON response

Users list

Flags

Examples

JSON response

Facts

`facts list` arguments

`facts list` flags

`facts get` flags

Examples

JSON response

Search

Arguments

Flags

Examples

JSON response

Sources

List sources

Flags

Examples

Get a source

Flags

Examples

Destinations

Examples

Settings

Examples

SQL

Arguments

Flags

Examples

JSON response

Available views

Schema

Arguments

Examples

JSON response

Feedback

Flags

Examples

JSON response