Services

Search active agricultural service listings

Search active service listings that have a saved location. Filter by an exact category name, a term matching names, descriptions, categories or tags, and optionally latitude, longitude and radius in metres. Valid coordinates enable nearest-first ordering; otherwise results are newest first. Returns matching service details and optional included relationships. Use page and per_page, following meta.next_page. This search does not book services or contact providers.

get/services/search

Request

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

Query parameters

pageinteger

Select within paginated results

per_pageinteger

Number results to return

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

Search latitude, example, -36.66892826470023

longitudestring

Search longitude, example, 141.50273631693733

radiusstring

Search radius in meters

termstring

Free-text filter matched case-insensitively against name, description, category name and tags. Pass a tag to aggregate every service labelled with it (hashtag-style).

includestring
Example:owner,place.location

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: owner, category, city, city.location, place, place.location, location.

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": "service"
    }
  ]
}

Changes

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