Mobs

Mob

One mob: its name, head_count, archive state, diary counters (record_count, open_task_count), and current_paddock_id — the paddock the mob is in now, derived from its newest completed record that names a destination, and null while it has never been placed. Resolve the paddock with getPaddock or listPaddocks. The owning property is the farm relationship.

Move the mob with moveMob. Everything filed on it — the property, its current paddock, and its tasks and records — is listAssetResources with asset_type=mob. The task board alone is listTasks with asset_id. Any accepted member of the owning organization can read; a personal property is its owner's. withholding is the current drench interval still ahead, or null when the mob is clear.

get/mobs/{id}

Request

  • Base URL: https://api.purplegrain.com/api/v1
  • URL: https://api.purplegrain.com/api/v1/mobs/{id}
  • Auth: one of:
    • none
    • HTTP bearer

Path parameters

idstring required

Id of the record

Query parameters

includestring
Example:farm.organization

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

Successful

Example response

{
  "data": {
    "type": "mob"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.