---
title: "GET /v1/workspaces/{workspaceId}/onboarding/discovery"
method: GET
path: "/v1/workspaces/{workspaceId}/onboarding/discovery"
---

# GET /v1/workspaces/{workspaceId}/onboarding/discovery

`GET /v1/workspaces/{workspaceId}/onboarding/discovery`

## Request

- Base URL: `https://api.bangermail.com`
- URL: `https://api.bangermail.com/v1/workspaces/{workspaceId}/onboarding/discovery`
- Auth: HTTP bearer

## Response `200`

The current company and email-stack discovery.

- object
  - `data` WorkspaceDomainDiscovery, required
    - `domain` string, required
    - `scan_status` 'complete' | 'partial' | 'failed', required
    - `company` CompanyContextDiscovery, required
      - `domain` string, required
      - `website_url` string, uri, nullable, required
      - `website_status` 'available' | 'missing' | 'blocked' | 'error', required
      - `company_name` string, required
      - `summary` string, required
      - `audience` string, required
      - `offerings` string[], required
      - `logo_url` string, uri, nullable, required
      - `favicon_url` string, uri, nullable, required
      - `visual_identity` CompanyVisualIdentity, required
        - `colors` string[], required
        - `fonts` string[], required
        - `tone` string[], required
        - `source_confidence` 'high' | 'medium' | 'low', required
        - `hero_image_url` string, uri
        - `palette` object[], required
          - `value` string, required
          - `role` 'primary' | 'accent' | 'background' | 'surface' | 'text' | 'other', required
          - `name` string, required
        - `typography` object[], required
          - `family` string, required
          - `role` 'heading' | 'body' | 'mono' | 'other', required
          - `weights` integer[], required
        - `assets` object[], required
          - `url` string, uri, required
          - `kind` 'logo' | 'wordmark' | 'favicon' | 'hero', required
          - `source` string, required
        - `brand_summary` string, required
        - `imagery_style` string[], required
      - `source_snapshot` object, required
    - `dns_signals` DnsSignal[], required
      - `name` string, required
      - `type` 'MX' | 'TXT' | 'CNAME' | 'NS', required
      - `value` string, required
      - `ttl` integer, required
    - `dns_provider` DnsProviderDetection, required
      - `key` string, required
      - `name` string, required
      - `confidence` 'high' | 'medium' | 'low', required
      - `dashboard_url` string, uri, required
      - `evidence` DnsSignal[], required
        - `name` string, required
        - `type` 'MX' | 'TXT' | 'CNAME' | 'NS', required
        - `value` string, required
        - `ttl` integer, required
    - `provider_detections` ProviderDetection[], required
      - `key` string, required
      - `name` string, required
      - `categories` string[], required
      - `confidence` 'high' | 'medium' | 'low', required
      - `evidence` DnsSignal[], required
        - `name` string, required
        - `type` 'MX' | 'TXT' | 'CNAME' | 'NS', required
        - `value` string, required
        - `ttl` integer, required
    - `capability_summary` DiscoveryCapability[], required
      - `kind` 'work_mailbox' | 'transactional' | 'marketing' | 'deliverability', required
      - `label` string, required
      - `status` 'detected' | 'missing' | 'needs_review', required
      - `provider_keys` string[], required
      - `recommendation` 'connect' | 'setup_banger' | 'review', required
    - `recommended_connections` SetupConnectionRecommendation[], required
      - `key` string, required
      - `name` string, required
      - `category` 'email' | 'customer' | 'product' | 'work' | 'data', required
      - `priority` 'required' | 'recommended', required
      - `reason` string, required
      - `source` 'dns' | 'business_context' | 'opportunity_plan' | 'banger_recommendation', required
      - `setup_mode` 'oauth' | 'secure_credentials', required
      - `available` boolean, required
      - `provider_key` string
      - `evidence` DnsSignal[], required
        - `name` string, required
        - `type` 'MX' | 'TXT' | 'CNAME' | 'NS', required
        - `value` string, required
        - `ttl` integer, required
    - `connection_plan` DiscoveryConnectionPlanItem[], required
      - `capability` 'work_mailbox' | 'transactional' | 'marketing' | 'deliverability', required
      - `provider_key` string
      - `action` 'connect' | 'setup_banger' | 'review', required
      - `domain` string
    - `limitations` string[], required
    - `scanned_at` string, date-time, required
    - `confirmed_at` string, date-time, nullable, required

---

[API](https://skmtc.dev/bangermail/apis/banger-api.md) · [All operations](https://skmtc.dev/bangermail/apis/banger-api/llms.txt) · [OpenAPI document](https://skmtc.dev/bangermail/apis/banger-api/revisions/a149909267f9?raw)