---
title: "FieldSpot public API - Developers"
description: "Read-only, unauthenticated JSON API over public FieldSpot product information."
canonical: https://www.fieldspot.ai/developers.md
last-updated: 2026-10-05
---

# FieldSpot public information API

A small **read-only, unauthenticated** JSON API over content already published on this website: overview, platform modules, pricing and FAQ. It serves public marketing/product information only. There is **no customer-data API, no OAuth, no API keys and no write access**.

Base URL: https://www.fieldspot.ai/api/v1

## Endpoints (GET, plus one read-only POST batch)

- `/api/v1`: endpoint index
- `/api/v1/overview`: company overview
- `/api/v1/modules` and `/api/v1/modules/{slug}`: platform modules (territory-map, agent-workspace, playbooks, renewals-radar, analytics)
- `/api/v1/pricing`: pricing (free during early access)
- `/api/v1/faq`: FAQ, optional `?q=` keyword search
- `/api/v1/search?q=`: search modules, FAQ and pricing
- `POST /api/v1/batch`: run up to 10 of the read-only lookups above in one call

## Batch reads and Idempotency-Key

`POST /api/v1/batch` takes `{"requests":[{"id":"a","path":"/api/v1/pricing"}]}` (max 10; only overview, modules, modules/{slug}, pricing, faq and search paths) and returns `{"responses":[{"id","status","body"}]}`. It only reads public data, so batching is safe and repeatable. Send an `Idempotency-Key` header and repeating the same key and body within 10 minutes returns the identical cached response with `Idempotent-Replayed: true` (best-effort, per server instance); the same key with a different body returns 422.

## Pagination

`/api/v1/modules` and `/api/v1/faq` accept `limit` plus either `offset` or an opaque `cursor`. Responses include `pagination.nextCursor` and a `Link: rel="next"` header that uses `cursor`.

Errors are JSON: `{"error":{"code","message","hint","docs"}}` with 404 (unknown), 400 (bad input) or 405 (any other non-GET method).

## Versioning and deprecation policy

The API is versioned in the URL path; the current version is `v1` and it is not deprecated (no sunset scheduled). Additive changes happen within v1; breaking changes ship as a new path version. A deprecated version keeps running for at least 6 months, and its responses will carry `Deprecation` and `Sunset` headers plus a `Link: rel="deprecation"` header pointing to https://www.fieldspot.ai/developers#versioning. Every response has an `API-Version` header.

## Machine-readable resources

- OpenAPI 3.1: https://www.fieldspot.ai/openapi.json
- API catalog (RFC 9727): https://www.fieldspot.ai/.well-known/api-catalog
- LLM index: https://www.fieldspot.ai/llms.txt
- MCP endpoint: https://www.fieldspot.ai/mcp
- Natural-language ask endpoint: https://www.fieldspot.ai/ask

Please keep usage reasonable; responses are cached and there is no SLA.