Tasks

Search Tasks

Free-text search. term matches tags case-insensitively, so whp-until-2026 or import-<source-id> finds a group of records that were tagged that way. A drench saved with createTreatmentRecord has no tags unless a later updateTask added them; its product names live on treatment.products, which this search does not read. For one mob's history use listTasks.

get/tasks/search

Request

  • Base URL: https://api.purplegrain.com/api/v1
  • URL: https://api.purplegrain.com/api/v1/tasks/search
  • Auth: none declared

Query parameters

pageinteger
per_pageinteger
categorystring

Category name to filter on — a single, exact Category.name (see GET /categories). This is the only category filter; ids and multiple values are not accepted. An unknown name returns no results.

latitudestring
longitudestring
radiusstring
termstring

Free-text filter matched case-insensitively against name, description, category name and tags. Pass a tag such as whp-until-2026 or import-<source-id> to find that group. Does not search drench.products.

status'pending' | 'cancelled' | 'completed'

Filter on a single task status. Omit to return tasks in every status.

includestring
Example:producer,provider,service

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: producer, provider, category, place, place.location, service, service.owner, service.category, service.city, service.place, service.location, farm, parent, children, asset.

Response

Success. When the include query parameter is used, the response may contain an included array (JSON:API) or inlined related resources (application/json).

Example response

{
  "data": [
    {
      "type": "task"
    }
  ]
}

Changes

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