SITEMAP / DOCS / AGENTS

Account Brief

The B2B roll-up. Returns an account's contacts, opportunities, blockers, and trajectory in a single call. P50 latency 180ms. Backed by MCP tool get_account_brief.

Use this when your agent needs the full account picture, not just one contact. Examples: a CSM agent preparing for a QBR, a deal-desk agent summarizing a stalled opportunity, an exec-briefing agent that generates a one-pager.

01Request

GET /v1/account/{id}

ParamTypeNotes
idpathAccount ID.

Required scope: account:read.

02Examples

curl

curl https://api.waypath.app/v1/account/acct_4c2d \
  -H "X-API-Key: wp_live_..."

node-fetch

const res = await fetch(
  'https://api.waypath.app/v1/account/acct_4c2d',
  { headers: { 'X-API-Key': process.env.WAYPATH_API_KEY! } }
)
const brief = await res.json()

python

import os, requests
brief = requests.get(
    'https://api.waypath.app/v1/account/acct_4c2d',
    headers={'X-API-Key': os.environ['WAYPATH_API_KEY']},
    timeout=5,
).json()

MCP

const brief = await mcp.tools.get_account_brief({ id: 'acct_4c2d' })

03Response

{
  "account_id": "acct_4c2d",
  "name": "Acme Corp",
  "contacts": [
    {
      "customer_id": "cus_8af2",
      "name": "Jane Doe",
      "role": "VP Engineering",
      "sentiment": "neutral"
    },
    {
      "customer_id": "cus_8af3",
      "name": "Mark Stearns",
      "role": "CFO",
      "sentiment": "positive"
    }
  ],
  "opportunities": [
    {
      "id": "opp_19a",
      "stage": "negotiation",
      "amount": 84000,
      "close_date": "2026-06-15",
      "probability": 0.6
    }
  ],
  "blockers": [
    "procurement_review_q2",
    "legal_redlines_outstanding"
  ],
  "trajectory": "at_risk"
}

Field reference

FieldTypeNotes
account_idstringInternal Waypath ID.
namestringDisplay name.
contactsarrayAll contacts at the account. Sentiment is rolled up from their individual trajectory.
opportunitiesarrayOpen opportunities with stage, amount, close date, probability.
blockersstring[]Blockers that apply to the whole account, deduped across contacts.
trajectorystringAccount-level trajectory. One of expanding, steady, at_risk, churning.

04Errors

StatusCodeCause
401unauthenticatedMissing or invalid X-API-Key.
403forbidden_scopeKey lacks account:read.
404not_foundAccount does not exist.
429rate_limitedPer-key rate cap.

05See also