---
title: "Site Plan"
method: GET
path: "/api/v1/site-plans/{site_plan_id}"
tags: ["site plans"]
---

# Site Plan

`GET /api/v1/site-plans/{site_plan_id}`

## Request

- Base URL: `https://api.brumby.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.brumby.com/api/v1/site-plans/{site_plan_id}`
- Auth: HTTP bearer

## Path parameters

- `site_plan_id` string, uuid, required

## Response `200`

Successful Response

- SitePlanResponse
  - `site_plan_id` string, uuid, required
  - `farm_id` string, required
  - `device_id` string, nullable, required
  - `name` string, nullable, required
  - `status` string, required
  - `paddock_ids` string[], required
  - `ring` array[], required
    - number[]
  - `settings` object, required
  - `variants` object[], required
  - `chosen_variant` integer, nullable, required
  - `engine` object, required
  - `base_stations` BaseStationResponse[]
    - `base_station_id` string, uuid, required
    - `farm_id` string, required
    - `name` string, required
    - `lat` number, required
    - `lon` number, required
    - `ground_elevation_m` number, nullable, required
    - `mast_height_m` number, required
    - `radios` unknown[], required
      - unknown
    - `source` string, required
    - `planning` object, nullable, required
    - `notes` string, nullable, required
    - `created_by` string, required
    - `archived_at` string, date-time, nullable, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
    - `kind` string
    - `status` string
    - `device_id` string, nullable
    - `site_plan_id` string, uuid, nullable
    - `sort_order` integer
    - `backhaul` object, nullable
  - `created_by` string, required
  - `archived_at` string, date-time, nullable, required
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/brumby/apis/brumby-platform-api.md) - [All operations](https://skmtc.dev/brumby/apis/brumby-platform-api/llms.txt) - [OpenAPI document](https://skmtc.dev/brumby/apis/brumby-platform-api/revisions/fe185e20813e?raw)