---
title: "List Paddocks"
method: GET
path: "/paddocks"
tags: ["Paddocks"]
---

# List Paddocks

`GET /paddocks`

## Request

- Base URL: `https://api.purplegrain.com/api/v1`
- URL: `https://api.purplegrain.com/api/v1/paddocks`
- Auth: one of:
  - none
  - HTTP bearer

List paddocks for one property (`farm_id`), every property in a business
(`organization_id`), or, with neither, the acting account's properties
(the signed-in user's personal properties for an assistant connection).
`farm_id` takes precedence when both are supplied. Results are ordered
by name, case-insensitively, and access follows the property's visibility
and the caller's membership and connection grants.

Returns names, areas, land use, crop, boundaries, archive state,
record/task counters and `block_id`: the block the paddock sits in, null
for the home block. The blocks themselves (name, kind, members, area) are
the property's `blocks` (`getFarm`). Live paddocks only by default; `archived=true`
selects archived ones and `archived=all` includes both. Use `page` and
`per_page` (default 200), following `meta.next_page`; no total is returned.
Use `include` to expand the owning property. This lookup does not change data.

## Query parameters

- `farm_id` string
- `organization_id` string
- `archived` string
- `page` integer
- `per_page` integer
- `include` string

## Response `200`

Paddocks for the requested property, business or acting account.

- PaddocksIndexResponseAttributes
  - `data` PaddockModelAttributes[]
    - `id` string
    - `type` string
    - `slug` string: Unique within its parent (a property per owner; a paddock or mob per property); generated from the name and renamed with it. The old slug keeps resolving. See `resolveLink`.
    - `web_path` string: The address on the web. Present when read directly.
    - `url` string: The whole link; carries the property's `?share=` token when it is shared by link. Present when read directly.
    - `name` string
    - `area_ha` number, nullable: Paddock area in hectares. Measured from the boundary when `area_source` is `drawn`; the farmer's own number when it is `typed`.
    - `area_source` 'typed' | 'drawn', nullable: Where `area_ha` came from. A `typed` area is never overwritten by a drawn one.
    - `land_use` 'cropping' | 'grazing' | 'mixed' | 'fallow', nullable
    - `current_crop` string, nullable
    - `boundary` array[], nullable: The paddock outline: an array of rings, each ring an array of `[longitude, latitude]` pairs in RFC 7946 order — **longitude first** — with at least 4 positions and the first repeated last. Not a GeoJSON object (see `PaddockBoundaryModel`).
      - array[]: One closed exterior ring.
        - number[]: [longitude, latitude]
    - `has_boundary` boolean: Whether the paddock has an outline at all — the cheap face of `boundary`.
    - `withholding` object, nullable: Is the paddock under a grazing or harvest withholding period right now? The latest spray record whose graze or harvest date is still ahead, or null. **Derived, not stored.** Read-only. Served on the paddock's own read and on lists (SPRAY_RECORD.md).
      - `task_id` string
      - `record_id` string: The SprayRecord id.
      - `safe_to_graze_on` string, date, nullable
      - `safe_to_harvest_on` string, date, nullable
      - `products` string[]
    - `boundary_captured_at` string, date-time, nullable
    - `boundary_source` 'traced' | 'grid' | 'gps' | 'imported', nullable: How the ring was captured — traced over imagery, placed on the grid with no imagery, walked with the phone's GPS, or read from a KML/shapefile. Null for a ring saved before provenance was recorded or by a caller that named no source. Written with the ring and cleared with it.
    - `boundary_captured_by` string, nullable: Id of the user who saved the ring, stamped server-side from the request's actor and never accepted from a client. Null when a machine token saved it, and null while the paddock has no ring.
    - `archived` boolean: An archived paddock leaves the map and the lists; its records stay on the property.
    - `archived_at` string, date-time, nullable
    - `block_id` string, uuid, nullable: The block the paddock sits in. Null in the home block.
    - `record_count` integer: Completed rows on this paddock — its diary.
    - `open_task_count` integer: Pending rows on this paddock.
    - `last_record_at` string, date-time, nullable
    - `created_at` string, date-time
    - `updated_at` string, date-time
    - `farm` object: Present when include=farm
  - `meta` PaginationMeta
    - `current_page` number
    - `next_page` number, nullable
    - `prev_page` number, nullable

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found — neither `farm_id` nor `organization_id` names a record the caller can see.

---

[API](https://skmtc.dev/purplegrain/apis/purple-grain-api.md) · [All operations](https://skmtc.dev/purplegrain/apis/purple-grain-api/llms.txt) · [OpenAPI document](https://skmtc.dev/purplegrain/apis/purple-grain-api/revisions/29c5c990d66e?raw)