See
whoami
GETFreereadread-only
Returns the authenticated Scope plan. Default view=compact is plan, remaining, committed burn, this_business, weekly_brief, and next[]. Pass view=full for upgrade_policy, skip_engines_down, recent_spend, and rate limits. Use when the user asks what plan they are on, how many checks they have left, or whether the agent is connected.
When to use
when the user asks what plan they are on, how many checks they have left, or whether the agent is connected.
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
business_id | string | no | — | Optional business to label the weekly brief for |
view | compact | full | no | compact | compact is the default card; full returns the kitchen-sink payload. |
REST path: GET /v1/whoami · All tools