List Paddocks
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.
Request
- Base URL: https://api.purplegrain.com/api/v1
- URL: https://api.purplegrain.com/api/v1/paddocks
- Auth: one of:
- none
- HTTP bearer
Query parameters
One property's paddocks. Takes precedence over organization_id; both owner filters may be omitted for the acting account's properties.
Every paddock across the business's properties — the organization-wide board and the composer's cross-farm list. With neither this nor farm_id, every paddock across the signed-in user's personal properties.
false (the default) for live paddocks, true for archived ones only, all for both.
Comma-separated snake_case relationship paths to embed (JSON:API included array, or inlined for application/json). Never embedded by default; unknown paths ignored; dot notation selects children; max 10 paths. Allowed paths: farm, farm.organization.
Response
Paddocks for the requested property, business or acting account.
Example response
{
"data": [
{
"type": "paddock"
}
]
}Changes
No recorded changes to this operation across all 2 revisions of this API.