---
title: "Read Device Sim World"
method: GET
path: "/api/v1/devices/{device_id}/sim-world"
tags: ["simulated worlds"]
---

# Read Device Sim World

`GET /api/v1/devices/{device_id}/sim-world`

## 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/devices/{device_id}/sim-world`
- Auth: HTTP bearer

## Path parameters

- `device_id` string, required

## Response `200`

Successful Response

- DeviceSimWorldResponse: Which world a simulated device should be flying, and what it holds. `world` is resolved through the device's active installation -- there is no separate selection to disagree with it.
  - `device_id` string, required
  - `world` SimWorldResponse, required: A flyable farm, as the sim picker sees it. Everything but the profile's own fields is read from the farm each time: nothing here is a stored copy, so moving a fence changes this answer.
    - `farm_id` string, required
    - `farm_name` string, required
    - `world_slug` string, required
    - `default_paddock` string, nullable, required
    - `origin_latitude` number, nullable, required
    - `origin_longitude` number, nullable, required
    - `origin_elevation_m` number, nullable, required
    - `paddock_count` integer, required
    - `generator_args` object, nullable, required
    - `notes` string, nullable, required
    - `buildable` boolean, required
  - `reported_world` string, nullable, required
  - `reported_built` string[], required
  - `reported_phase` string, nullable, required
  - `reported_at` string, date-time, nullable, required
  - `ready` boolean, required
  - `in_sync` boolean, 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)