locations

List Locations

List premises and sublocations for the farm, including identifiers and the parent path. Directory scopes use read:farms/write:farms; minimum farm role READER for reads and EDITOR for writes.

get/v1/farm/{farm_id}/locations

Request

  • Base URL: https://api.ranch.bot
  • URL: https://api.ranch.bot/v1/farm/{farm_id}/locations
  • Auth: HTTP bearer

Path parameters

farm_idstring uuid required

Query parameters

include_archivedboolean

Response

Success

totalnumber required

Changes

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