API Docs

API access

The Farm Dashboard is built on a JSON API, and the same API is available to customers for integrations such as water quality sensors, accounting systems and business-intelligence tools. Access is available on request: tell us what you would like to connect, and we will set up access for your account and share the documentation for the endpoints you need.

• Every request is limited to your own account, and to the farms and permissions of the user it acts for.
• Requests and responses are JSON over HTTPS; amounts use your account’s currency and times are in UTC.
• Writes are validated exactly as in the dashboard, and important changes are recorded in the audit log.
• Requests are rate-limited to protect the service; a limited request receives HTTP 429.

Service status

A public health endpoint reports whether the service and its database are up. It needs no authentication.

GET /api/health

200 OK
{ "status": "ok", "db": "up", "migration": { "ok": true }, "time": "2026-11-04T09:00:00.000Z" }

If the database is unreachable, status is "error" and the response code is 503. Check the status now.

Exports without the API

Most integrations start with data the dashboard already exports. Reports download as Excel or PDF (depending on your plan), with the same filters as on screen.

Payments

Online payments are processed by Razorpay. Payment notifications go only to our own signed endpoint; there is no public payments API.