Skip to main content

DocsREST API and MCP server

Purchases API

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

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

Account: Purchases

List Purchases

This account's paid orders, newest first (up to 200). Unpaid and refunded orders are not listed. Lists the account has archived in the web app are left out unless includeArchived is set; customName is the name the account gave the list (null when it kept the order's listName).

GEThttps://us-farmvision-new-api.onrender.com/api/v1/purchases/Try 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

Query parameters

FieldTypeDescription
includeArchivedquerystringSend 1 or true to include archived lists.

Mounted at

/api/v1/purchases

Paid Navigator orders: list them, preview their rows and download them as CSV or Excel. Also builds checkout links that open the GTM Scoop checkout pre-loaded with a search, which is how an integration or AI assistant hands a purchase to a person to pay for.

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

Bearer token: an llmcp_ API key or a signed-in session; the file download also takes a short-lived download token.

MethodPathWhat it does
GET/api/v1/purchases/

List Purchases

This account's paid orders, newest first (up to 200). Unpaid and refunded orders are not listed. Lists the account has archived in the web app are left out unless includeArchived is set; customName is the name the account gave the list (null when it kept the order's listName).

1 parameter
  • includeArchived (string) Send 1 or true to include archived lists.
Try List Purchases in the Playground
POST/api/v1/purchases/checkout-link

Create Checkout Link

Builds a link to the GTM Scoop checkout pre-loaded with a search, for a person to open, choose a plan and pay; the match counts are recounted on the server and returned with it. Nothing is charged here. The link expires after 30 minutes and only opens for the same account; 20 links per 10 minutes (429).

7 parameters
  • datasets (array, required) One or more of "farm", "business", "property".
  • farmFilters (object) Farm criteria in the Farm Data Search /count shape. Required when datasets includes farm.
  • businessActive (array) Business criteria as { id, filterId, values, exclude } objects. Required when datasets includes business.
  • businessGeoPlaceScope (object) Optional { "statesNarrowed": [...] } geography scope for Business.
  • propertyActive (array) Property criteria as { id, filterId, values, exclude } objects. Required when datasets includes property.
  • propertyGeoPlaceScope (object) Optional { "statesNarrowed": [...] } geography scope for Property.
  • listName (string) A name for the list, trimmed to 50 characters.
GET/api/v1/purchases/checkout-link

Read Checkout Link

Turns a checkout-link token back into the search it carries; the checkout page calls this when it opens. 400 once the link has expired, 403 if it was made for another account.

1 parameter
  • token (string, required) The mcp= value from a /checkout-link URL.
Try Read Checkout Link in the Playground
GET/api/v1/purchases/:id

Get Purchase

One paid order: its criteria, datasets, records bought per dataset, export columns and amount. 404 if it is not yours or not paid.

1 parameter
  • id (string, required) The purchase id.
Try Get Purchase in the Playground
GET/api/v1/purchases/:id/refund-request

Get Refund Request Status

Whether this order can ask for a refund now, and the request already made, if any. A one-time order paid by card can ask within 14 days of purchase. After that, with no request made, canRequest is false and request is null. status is "pending", "refunded" or "rejected".

1 parameter
  • id (string, required) The purchase id.
Try Get Refund Request Status in the Playground
POST/api/v1/purchases/:id/refund-request

Request a Refund

Asks for a refund and no more: an admin reviews the request, decides whether to refund and how much, and the customer is emailed the decision. No money moves until then. One request per order. A signed-in browser session only: an API key or MCP token gets 403. 403 too once the 14 days have passed, 409 if this order already asked.

2 parameters
  • id (string, required) The purchase id.
  • reason (string, required) Why you are asking, 10 to 1,000 characters.
GET/api/v1/purchases/:id/preview

Preview Purchase Rows

A page of rows from one dataset of a paid order, with the same columns and values as the download. total is the number of records bought; paging stops at maxDepth (5,000 rows), past which you download the file instead.

4 parameters
  • id (string, required) The purchase id.
  • dataset (string, required) "farm", "business" or "property". 403 if the order did not include it.
  • limit (integer) Rows to return, 1–100. Default 25.
  • offset (integer) Rows to skip. Default 0; capped so offset + limit stays within 5,000.
Try Preview Purchase Rows in the Playground
GET/api/v1/purchases/:id/export-link

Get Download Link

Returns a download path with a one-file token, for a browser that cannot send an Authorization header: open it on this API's host. The token only works for this order, dataset and format, and expires after 90 seconds.

3 parameters
  • id (string, required) The purchase id.
  • dataset (string, required) "farm", "business" or "property". 403 if the order did not include it.
  • format (string) "csv" (default) or "xlsx".
GET/api/v1/purchases/:id/export

Download Purchase

Streams every purchased row of one dataset as a file named <order number>_final_<dataset>. CSV has no row limit; Excel holds at most 1,048,575 rows, and a bigger dataset gets a 400 asking for CSV. Send the Bearer header, or use the token from /export-link in its place (401 once expired, 403 if it does not match this URL).

4 parameters
  • id (string, required) The purchase id.
  • dataset (string, required) "farm", "business" or "property". 403 if the order did not include it.
  • format (string) "csv" (default) or "xlsx".
  • token (string) The download token from /export-link, used instead of the Authorization header.

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