Authentication
The FarmReady API uses Bearer token authentication. All requests to authenticated endpoints
must include an
Authorization
header.
Authorization: Bearer fr_<token>
Tokens are prefixed with
fr_
and are issued per customer account. A token may be scoped to one or more organisations,
or granted access to all organisations belonging to the customer.
Obtaining a token
To get API access, contact FarmReady support. Tokens are shown only once at creation time — store them securely.
Tokens do not expire automatically. To revoke access, delete the token from your account settings. If you need to rotate a token used across multiple integrations, generate a new token first, update your integrations, then delete the old one.
Token permissions
Tokens may be created as read-only
or read/write. A read-only token will receive a
403 Forbidden
response
on any mutating request (POST, PATCH, DELETE).
Organisation scoping
When a token is scoped to specific organisations, requests to resources belonging to
other organisations return
403 Forbidden
even if the organisation belongs to the same customer account.
Errors
{"error": "unauthorized"}{"error": "forbidden"}