This API is in beta. Endpoints and response shapes may change before stable release.

Organisations

An organisation is the top-level entity in FarmReady. All Shed resources (receipts, returns, storages, products) belong to an organisation. Your API token determines which organisations are accessible.

The organisation object

Field Type Mutability Notes
id uuid system
name string system Organisation name.
inserted_at iso8601 system
updated_at iso8601 system

List organisations

GET /api/organisations

Returns all organisations the token has access to. If the token is scoped to specific organisations, only those are returned.

200 
{
  "data": [
    {
      "id": "<uuid>",
      "name": "<string>",
      "inserted_at": "<iso8601>",
      "updated_at": "<iso8601>"
    }
  ]
}

Get an organisation

GET /api/organisations/:id
200 
{
  "id": "<uuid>",
  "name": "<string>",
  "inserted_at": "<iso8601>",
  "updated_at": "<iso8601>"
}