Call the getCreditBalance MCP tool
Return the visitor's current credit balance, whether credits are frozen (and the freeze reason), and a short list of recent credit transactions. Use for "how many credits do I have", "why are my credits frozen", "what consumed my credits". Do NOT use for subscription/plan/payment questions. That's getBillingStatus. Do NOT use for LinkedIn account send limits. That's getLinkedInAccounts. Bound to the visitor's workspace.
Called through the Actions bridge: the response is that tool's own result, wrapped as { data: <tool result> } under HTTP 200. Billing, daily-cap, and confirm-step outcomes are embedded INSIDE data, never remapped to an HTTP status (see the templated /api/v1/actions/{toolName} operation above for the full protocol, and x-mcp-actions for this tool's machine-readable scope/cap/confirm_behavior fields). Authentication, request-shape, and optional idempotency-protocol failures still use their documented non-200 statuses.
Request
- Base URL: https://app.reachium.io
- URL: https://app.reachium.io/api/v1/actions/getCreditBalance
- Auth: HTTP bearer
Headers
Optional caller-generated key (8-200 characters: letters, digits, dot, underscore, colon, or hyphen). A final tool result is replayed for the same key and body. An ambiguous result remains 409 under that key; reconcile external state before using a new key. Reuse with a different body returns 422.
Request body
Response
The result of calling this tool.
Changes
No recorded changes to this operation across all 1 revision of this API.