Pipeline overview: one row per pipeline with stage counts, open value and next step

The approved contract does not provide a longer purpose statement for this operation.

App

CRM

Contract

CRM API 9.12.1

Lifecycle

preview

Runtime

restricted

Operation ID

getPipelineOverview

Canonical origin

Not declared; gateway routing required

Purpose and use cases

Pipeline overview: one row per pipeline with stage counts, open value and next step

The owning App is Vision CRM. CRM owns its records, workflow rules, workspace membership, provenance, and record-level authorization.

Business use cases and out-of-scope behavior are not yet declared in the approved OpenAPI description.

Request

GET /api/crm/v1/pipelines/overview

This contract intentionally declares no direct server URL. Obtain the routed App origin before attempting the request.

Authentication and authorization

Send a Vision-issued bearer token for the exact App audience. The token must include the crm entitlement and satisfy the crm workspace required binding.

• Required scope: crm:opportunities:read

Human roles are not declared in OpenAPI. Record-level and business permission checks remain the owning App's authority.

Headers

• Authorization: Bearer <access-token> — required.
• Accept: application/json — recommended where a JSON response is declared.

Undeclared tracing, idempotency, conditional-request, and version headers are not assumed on this page.

Path and query parameters

Request body

This operation declares no request body.

Runnable examples

curl '${APP_BASE_URL}/api/crm/v1/pipelines/overview' \
  --request GET \
  --header 'authorization: Bearer ${ACCESS_TOKEN}' \
  --header 'accept: application/json'

const response = await fetch('${APP_BASE_URL}/api/crm/v1/pipelines/overview', {
  method: 'GET',
  headers: {
    authorization: `Bearer ${ACCESS_TOKEN}`,
    accept: 'application/json',
  },
}

if (!response.ok) throw new Error(`Vision API ${response.status}`)
const result = await response.json()

import json
import urllib.parse
import urllib.request

request = urllib.request.Request(
    '${APP_BASE_URL}/api/crm/v1/pipelines/overview',
    data=None,
    headers={
    "Accept": "application/json",
    "Authorization": "Bearer <ACCESS_TOKEN>"
},
    method='GET',
)
with urllib.request.urlopen(request, timeout=30) as response:
    result = json.load(response)

The current TypeScript reference client covers Platform token exchange and core reads. No native SDK helper is declared for this operation; use the HTTP contract directly and follow the SDK guidance.

Responses

Success response schema

{
  "schemaVersion": "vision-crm-pipeline-overview.v1",
  "items": [
    {
      "id": "00000000-0000-4000-8000-000000000001",
      "key": "<key>",
      "label": "<label>",
      "hint": "<hint>",
      "badge": "<badge>",
      "isDefault": true,
      "stages": [
        {
          "label": "<label>",
          "count": 0,
          "valueText": "<valueText>",
          "colorToken": "slate"
        }
      ],
      "openValueMinor": 0,
      "openValueCurrency": "<openValueCurrency>",
      "openDealCount": 0,
      "openDealsText": "<openDealsText>",
      "nextStepTitle": "<nextStepTitle>",
      "nextStepDueAt": "2026-08-21T18:00:00Z",
      "recordVersion": 1
    }
  ],
  "includesSample": true
}

Errors and troubleshooting

Error bodies and codes are shown only where the approved contract declares them. Use status, the declared error schema, and any correlation identifier returned by the App; do not infer that two Apps share one envelope.

• 400 — The request is invalid

Collection behavior

Pagination: not declared. Filtering/search: not declared. Sorting: not declared.

Cursor lifetime, cursor binding, stable ordering, maximum traversal, and unknown-filter behavior are not assumed unless stated by a parameter description or schema constraint above.

Operational behavior

• Rate limit: No operation-specific limit or 429 response is declared.
• Retry: Retry only when the documented error model or response headers authorize it. Timeout and backoff values are not declared by this operation.
• Idempotency: No idempotency header or replay window is declared.
• Concurrency: No ETag, If-Match, or optimistic-version header is declared.

Security and privacy

• Keep client credentials and bearer tokens on trusted servers.
• Send only to the exact approved HTTPS origin and audience.
• Treat response data according to the owning App's classification and retention policy; the OpenAPI contract does not itself grant data access.
• Do not log credentials, tokens, complete private payloads, or secrets.

Edge cases and known documentation gaps

• No detailed operation description.
• No direct server URL; gateway routing is unresolved here.
• Business roles, timeout, retry budget, rate value, idempotency window, and concurrency behavior are absent unless explicitly stated above.

Related operations and workflows

• GET /api/crm/v1/meta — Contract and version metadata
• GET /api/crm/v1/today — Explainable CRM attention queue
• GET /api/crm/v1/intake-submissions — Paginated quarantined intake queue
• POST /api/crm/v1/intake-submissions — Submit a lead from a website form
• GET /api/crm/v1/intake-submissions/{reference} — Quarantined intake detail and provenance
• GET /api/crm/v1/people — Browse canonical people
• GET /api/crm/v1/people/{reference} — Read a canonical person briefing
• GET /api/crm/v1/organizations — Browse canonical organizations

Contract history and evidence

• Contract version: 9.12.1
• Approved snapshot SHA-256: 0f1f55d7aa33ad048b56ae7a49cf674933cf2e73b6635f606da13eb92e1534f7
• Approval: Anthony, 2026-11-03T01:45:33.272Z (anthony-docs-live-20261102)
• Download the authoritative OpenAPI 3.1 snapshot