List Mobs
The mobs of one property (farm_id) or of every property in a farm business (organization_id), ordered by name, case-insensitively. With neither parameter the list is only the signed-in user's personal-property mobs. A business's mobs are missing until you pass farm_id or organization_id. getFarmPicture is every mob on one property in one call.
A mob belongs to its property, not to a paddock: each one carries current_paddock_id, the paddock it is in now (derived from its latest completed move, null while it has never been placed). Move it with moveMob.
Live mobs only by default — pass archived=true for the archive drawer or archived=all for both. The default page holds a whole property's mobs (200) so a client can render "2 placed · 1 unplaced" without a second request; meta carries no total, so a truncated page is a wrong number on screen rather than a missing row.
Any accepted member of the owning organization can list, a viewer included.
Request
- Base URL: https://api.purplegrain.com/api/v1
- URL: https://api.purplegrain.com/api/v1/mobs
- Auth: one of:
- none
- HTTP bearer
Query parameters
One property's mobs. Supply either this or organization_id.
Every mob across the business's properties — the organization-wide board and the composer's cross-farm list. With neither this nor farm_id, every mob across the signed-in user's personal properties.
false (the default) for live mobs, 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
Mobs for the property or the business.
Example response
{
"data": [
{
"type": "mob"
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.