Services

List one provider's service listings

List agricultural service listings for owner_id; owner_type selects users or organizations and defaults to a user. Without owner_id the result is empty. Optional filter[id][] and filter[status][] narrow that owner's listings. Returns descriptions, advertised costs, currencies, tags and image URLs; include expands supported owner, category and place details. Use page and per_page, following meta.next_page. This lookup does not book or change services.

get/services

Request

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

Query parameters

pageinteger

Select within paginated results

per_pageinteger

Number results to return

owner_idstring

Owner ID to filter on

owner_typestring

Owner Type to filter on

filter[id][]string[]

ID to filter on

filter[status][]string[]

Status to filter on

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.