Skip to main content

DocsREST API and MCP server

Enrichment Credits API

Endpoints, auth and live samples for Audience Builder, Connect Data and CRM sync.

Base URLhttps://us-farmvision-new-api.onrender.com

Account: Enrichment Credits

Get Credit Balances

Returns both balances: credits (enrichment credits) and monthlyState (the monthly record allowance), each with allowance, used and remaining, plus the period end they renew at. planType is "autopay_299" (Starter) or "autopay" (Growth); an account without a plan reads an allowance of 0. Read-only.

GEThttps://us-farmvision-new-api.onrender.com/api/v1/lead-generation/mcp/creditsTry it

In this section

Authentication

Get API key

Bearer token

Send your GTM Scoop API key (llmcp_…) or a signed-in session token as a Bearer token.

Authorization: Bearer YOUR_API_KEY

Parameters

This endpoint takes no parameters or request body.

Mounted at

/api/v1/lead-generation

Your two separate balances for the current billing period: enrichment credits (200 on Starter, 500 on Growth), spent by every enrichment whether it starts in the app, over MCP or through this API, and the monthly record allowance (2,500 / 10,000), spent by AI analysis and purchases. Both renew when the subscription renews; read them before a large start to avoid a 402.

Try it in the playground

Signed out: 10 free tries a day with names hidden. Log in for live data.

Open playground

Related endpoints

All 2 endpoints in this section

Bearer token (llmcp_ API key or session).

MethodPathWhat it does
GET/api/v1/lead-generation/mcp/credits

Get Credit Balances

Returns both balances: credits (enrichment credits) and monthlyState (the monthly record allowance), each with allowance, used and remaining, plus the period end they renew at. planType is "autopay_299" (Starter) or "autopay" (Growth); an account without a plan reads an allowance of 0. Read-only.

Try Get Credit Balances in the Playground
POST/api/v1/lead-generation/mcp/credits/preview

Preview Credit Cost

Checks a planned enrichment, or enrichment followed by an analysis of the same size, against your balances without spending anything, and returns a ready-to-show confirmation message. sufficient is true when the balances cover recordCount; maxRecords is the most the relevant balance allows. Without recordCount it returns the balances and a prompt asking how many records to enrich.

3 parameters
  • recordCount (integer) Records you plan to enrich: a whole number from 1 to 10,000,000, else 400. Omit it to get a how-many prompt instead of a cost.
  • enrichType (string) "enrich" (default): checks enrichment credits only. "enrich_and_analysis": also checks the monthly record allowance for an analysis of recordCount prospects. Any other value is treated as "enrich".
  • rowsAvailable (integer) Only used without recordCount: the rows in your file, to cap the number the prompt suggests. Invalid values are ignored.

Cookies on GTM Scoop

Essential cookies keep you signed in and the site secure, and are always on. Optional cookies (Google Analytics) help us understand how the site is used. They are on by default, except in the EU/EEA, the UK and Switzerland, where they stay off until you choose Accept All Cookies; choose Essential Cookies Only to turn them off. We do not use advertising cookies and we do not sell or share your personal information. The site works the same whichever you choose. We keep a record of your choice with the date, your IP address and the page you were on. Cookie Policy · Privacy Policy