API Reference
Livestork exposes an organisation-scoped REST API for integrating your own tools with farm data; the same API the Livestork application itself is built on.
Overview
Every resource in the API is scoped to a single organisation; a request authenticated with your key can only read and write data belonging to your own organisation. Requests are validated against your subscription plan, so features unavailable on your plan return a clear error rather than partial data.
Authentication
Generate an API key from your organisation's Developer settings inside the application, then send it as a bearer token on every request:
Authorization: Bearer lsk_live_a1b2c3d4e5f6...Keys can be scoped to specific permissions when you create them, so a key used for a read-only reporting integration can be limited to read access only.
Keep your keys secret
Base URL & response format
All endpoints are namespaced under your organisation:
https://api.livestork.com/v1/organizations/{organization}/{resource}Every response uses a consistent envelope:
{
"success": true,
"data": { ... },
"meta": { "pagination": { "current_page": 1, "total": 42 } }
}Rate limits
Requests are rate-limited per key. If you exceed your limit, the API returns429 Too Many Requestswith a Retry-After header.
Available resources
A representative selection of what's available; every resource supports standard list/create/show/update operations unless noted otherwise.
| Area | Resources |
|---|---|
| Farm Operations | farms, farm-sites, production-units, batches, feed-allocations, feed-logs, dispatches |
| Supply Chain | inventory-items, stock-locations, vendors, purchase-orders, purchase-requests, supplier-invoices |
| Sales | customers, sales-orders (submit, approve, close) |
| Operations | daily-logs, feed-types, tax-rates, fixed-assets |
Example request
Fetching active batches for an organisation:
curl https://api.livestork.com/v1/organizations/{organization}/batches \
-H "Authorization: Bearer lsk_live_a1b2c3d4e5f6..." \
-H "Accept: application/json"Webhooks
Webhook endpoints can be registered against an event catalog today, but outbound delivery on domain events (e.g. a batch closing or a sales order being approved) is not yet live. If your integration needs real-time notifications, poll the relevant resource for now; we'll update this page when delivery ships.
Need a key?