Skip to main content

DocsREST API and MCP server

Enrichment API

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

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

Connect Data: Enrichment

Start Enrichment

Starts the business enrichment of a run: each row is matched by phone, then email, then street address + ZIP, against the business and farm reference data. Returns 201 with the new job, or 200 with the enrichment already running on this run (never charged twice). 402 without an active plan or when fewer enrichment credits remain than the upload has rows, 400 if the upload has no saved mapping, 404 for an unknown run, 409 while a duplicate start is still settling.

POSThttps://us-farmvision-new-api.onrender.com/api/v1/lead-generation/runs/:runId/enrich-jobsTry 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

application/json
FieldTypeDescription
runIdpathrequiredstringThe run, from Start a Run. Its upload needs a saved mapping.
autoChainAnalysisbodybooleantrue: when this enrichment completes, the server starts an AI analysis of the run itself, with no client watching. Default false. Find that analysis job in GET /runs/:runId/match-jobs.
analysisSourcebodystringOnly with autoChainAnalysis. The data the chained analysis searches: "business" (default), "farm" or "property". Any other value means no analysis is started; the enrichment still completes.
prospectCountbodyintegerOnly with autoChainAnalysis. Prospects the chained analysis delivers: a whole number from 1 to 5,000, else 400. Omitted: 1. Reserved from the monthly record allowance when the analysis starts.
previewRowsbodyarrayIgnored. The web app still sends the parsed rows here, but the job always enriches every row of the run's saved upload, so leave it out.

Mounted at

/api/v1/lead-generation

Matches every row of a run's mapped upload against GTM Scoop's reference data as an asynchronous job: start it, then poll the job until status is completed or failed, then read the run's results. Each start needs an active Navigator subscription ($299 Starter or $899 Growth) and reserves one enrichment credit per upload row, charging only the rows that matched (a failed job costs nothing); an account can run three jobs at once and start 120 an hour (429 beyond either).

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 11 endpoints in this section

Bearer token (llmcp_ API key or session). Starts need an active Navigator plan and enrichment credits.

MethodPathWhat it does
POST/api/v1/lead-generation/runs/:runId/enrich-jobs

Start Enrichment

Starts the business enrichment of a run: each row is matched by phone, then email, then street address + ZIP, against the business and farm reference data. Returns 201 with the new job, or 200 with the enrichment already running on this run (never charged twice). 402 without an active plan or when fewer enrichment credits remain than the upload has rows, 400 if the upload has no saved mapping, 404 for an unknown run, 409 while a duplicate start is still settling.

5 parameters
  • runId (string, required) The run, from Start a Run. Its upload needs a saved mapping.
  • autoChainAnalysis (boolean) true: when this enrichment completes, the server starts an AI analysis of the run itself, with no client watching. Default false. Find that analysis job in GET /runs/:runId/match-jobs.
  • analysisSource (string) Only with autoChainAnalysis. The data the chained analysis searches: "business" (default), "farm" or "property". Any other value means no analysis is started; the enrichment still completes.
  • prospectCount (integer) Only with autoChainAnalysis. Prospects the chained analysis delivers: a whole number from 1 to 5,000, else 400. Omitted: 1. Reserved from the monthly record allowance when the analysis starts.
  • previewRows (array) Ignored. The web app still sends the parsed rows here, but the job always enriches every row of the run's saved upload, so leave it out.
GET/api/v1/lead-generation/runs/:runId/enrich-jobs/:jobId

Get Enrichment Job

Reads one enrichment job. Poll it every few seconds until status is completed or failed (a failed job carries a readable error); matchesFound is the number of rows that matched a record, which is what the job is charged. 404 if the job is not on this run or not yours.

2 parameters
  • runId (string, required) The run the job belongs to.
  • jobId (string, required) The id returned by Start Enrichment.
Try Get Enrichment Job in the Playground
POST/api/v1/lead-generation/runs/:runId/farm-enrich-jobs

Start Farm Enrichment

Starts a farm-only enrichment: each row is matched by phone, then email, then street address + ZIP, against the farm reference data alone. Same plan, credit, 201/200 and error rules as Start Enrichment, and it shares one active farm job per run with Start Farm Enrichment + Analysis (either route returns a farm job the other started). Use this route for enrichment on its own; if you want an analysis to follow automatically, use gtmscoop-farm-enrich-jobs, which lets you choose the analysis data and size.

2 parameters
  • runId (string, required) The run, from Start a Run. Its upload needs a saved mapping.
  • automated (boolean) true: when enrichment completes, the server starts a farm AI analysis at the default size of 1 prospect. Default false. To choose the data and prospect count, use gtmscoop-farm-enrich-jobs instead.
GET/api/v1/lead-generation/runs/:runId/farm-enrich-jobs

List Farm Enrichment Jobs

Every farm enrichment job on this run, newest first (up to 100), finished ones included, whichever farm route started them. Use it to find a job you lost track of; stale is true for a running job that has stopped reporting for a while. An unknown run returns an empty list.

1 parameter
  • runId (string, required) The run whose jobs to list.
Try List Farm Enrichment Jobs in the Playground
GET/api/v1/lead-generation/runs/:runId/farm-enrich-jobs/:jobId

Get Farm Enrichment Job

Reads one farm enrichment job; poll it until status is completed or failed. 404 unless the job is a farm enrichment of this run that you own.

2 parameters
  • runId (string, required) The run the job belongs to.
  • jobId (string, required) A farm enrichment job id, from either farm start route.
Try Get Farm Enrichment Job in the Playground
POST/api/v1/lead-generation/runs/:runId/gtmscoop-farm-enrich-jobs

Start Farm Enrichment + Analysis

The same farm-only enrichment as farm-enrich-jobs (same matching, credits, rules and shared farm job per run), plus an optional AI analysis you configure: with automated: true the server starts it on the data and prospect count you choose as soon as enrichment completes. GTM Scoop accounts only (404 for anyone else). Without automated it behaves exactly like farm-enrich-jobs.

4 parameters
  • runId (string, required) The run, from Start a Run. Its upload needs a saved mapping.
  • automated (boolean) true: start an AI analysis on the server as soon as the enrichment completes. Default false (enrichment only; the two fields below are then ignored). Find the analysis job in GET /runs/:runId/match-jobs.
  • analysisSource (string) With automated. The data the analysis searches: "farm" (default), "business" or "property". Any other value is a 400.
  • prospectCount (integer) With automated. Prospects to deliver, capped at 5,000 (larger values are lowered, not refused). Omitted or not a positive number: the upload's row count, capped at 5,000. Reserved from the monthly record allowance when the analysis starts.
GET/api/v1/lead-generation/runs/:runId/gtmscoop-farm-enrich-jobs

List Farm Enrichment + Analysis Jobs

Every farm enrichment job on this run, newest first (up to 100), whichever farm route started them; the same list as List Farm Enrichment Jobs. GTM Scoop accounts only.

1 parameter
  • runId (string, required) The run whose jobs to list.
Try List Farm Enrichment + Analysis Jobs in the Playground
GET/api/v1/lead-generation/runs/:runId/gtmscoop-farm-enrich-jobs/:jobId

Get Farm Enrichment + Analysis Job

Reads one farm enrichment job; poll it until status is completed or failed. The chained analysis is a separate job: look for it in GET /runs/:runId/match-jobs once enrichment completes. GTM Scoop accounts only; 404 unless the job is a farm enrichment of this run.

2 parameters
  • runId (string, required) The run the job belongs to.
  • jobId (string, required) A farm enrichment job id, from either farm start route.
Try Get Farm Enrichment + Analysis Job in the Playground
POST/api/v1/lead-generation/runs/:runId/property-enrich-jobs

Start Property Enrichment

Starts a property enrichment: each row is matched against the property reference data by parcel number (APN), then by street address + ZIP; no phone or email is needed. Same plan, credit, 201/200 and error rules as Start Enrichment. With automated: true the server starts a property AI analysis as soon as enrichment completes.

3 parameters
  • runId (string, required) The run, from Start a Run. Its upload needs a saved mapping.
  • automated (boolean) true: start a property AI analysis on the server as soon as enrichment completes. Default false. Find that job in GET /runs/:runId/match-jobs.
  • prospectCount (integer) With automated. Prospects the analysis delivers: a whole number from 1 to 5,000, else 400. Omitted: the upload's row count, capped at 5,000. Reserved from the monthly record allowance when the analysis starts.
GET/api/v1/lead-generation/runs/:runId/property-enrich-jobs

List Property Enrichment Jobs

Every property enrichment job on this run, newest first (up to 100), finished ones included. An unknown run returns an empty list.

1 parameter
  • runId (string, required) The run whose jobs to list.
Try List Property Enrichment Jobs in the Playground
GET/api/v1/lead-generation/runs/:runId/property-enrich-jobs/:jobId

Get Property Enrichment Job

Reads one property enrichment job; poll it until status is completed or failed. 404 unless the job is a property enrichment of this run that you own.

2 parameters
  • runId (string, required) The run the job belongs to.
  • jobId (string, required) The id returned by Start Property Enrichment.
Try Get Property Enrichment Job in the Playground

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