Skip to content
Optiwork API Docs

Get the active world

GET
/spaces/maps/active
curl --request GET \
  --url https://spaces.work.optidata.cloud/api/spaces/maps/active \
  --header 'Authorization: Bearer <token>'

The world every space of the company is laid out from, with its map document. When the company never activated a world of its own, source is builtin, map_identifier names the built-in office and map is null. Open to everyone in the company.

Authorizations

Section titled “Authorizations”

Responses

Section titled “ Responses ”

200

Section titled “200”

The active world.

Media typeapplication/json
object
source
required
string
Allowed values: tenant builtin
map_identifier
required

The active world’s identifier, or the built-in office’s name.

string
version
required
integer | null
map
required
One of:
object
identifier
required
string
name
required
string
source_map

The world this one was copied from, if any.

string | null
status
required
string
Allowed values: draft active
is_active
required
boolean
version
required

Grows with every saved change.

integer
activated_at
string | null format: date-time
created_by_uuid
string | null
updated_by_uuid
string | null
created_at
string format: date-time
updated_at
string format: date-time
data

A Tiled map in its JSON format (orthogonal, 32×32 tiles). It must carry type, width, height, tilewidth, tileheight and layers. The Spaces client reads a Ground tile layer and the object layers Wall, Chair, Objects, ObjectsOnCollide, GenericObjects, GenericObjectsOnCollide, Computer, Whiteboard, Basement and VendingMachine; the easiest way to get a valid document is to create a world without data and edit the blank one it returns.

object
type
required
string
Allowed value: map
width
required
integer
height
required
integer
tilewidth
required
integer
tileheight
required
integer
layers
required
Array<object>
object
key
additional properties
any
tilesets
Array<object>
object
key
additional properties
any
key
additional properties
any
group_areas

Zones of the world reserved for groups: an object keyed by group id, each holding the [x, y] tile cells of that group’s area. Members of the group may edit the world inside its area even when they are not builders. Cells must lie inside the map.

object | null
Examples

A world designed by the company

{
  "source": "tenant",
  "map_identifier": "a28e5bf3-26b4-4a34-9f98-9a116a2700ca",
  "version": 8,
  "map": {
    "identifier": "a28e5bf3-26b4-4a34-9f98-9a116a2700ca",
    "name": "Head office",
    "source_map": null,
    "status": "active",
    "is_active": true,
    "version": 8,
    "activated_at": "2026-08-24T15:27:23-03:00",
    "created_by_uuid": "2d9e8f70-1a3b-4c5d-8e9f-a0b1c2d3e4f5",
    "updated_by_uuid": "2d9e8f70-1a3b-4c5d-8e9f-a0b1c2d3e4f5",
    "created_at": "2026-08-21T11:38:37-03:00",
    "updated_at": "2026-08-24T15:27:23-03:00",
    "data": {
      "type": "map",
      "version": "1.10",
      "width": 40,
      "height": 40,
      "tilewidth": 32,
      "tileheight": 32,
      "orientation": "orthogonal",
      "layers": [],
      "tilesets": []
    },
    "group_areas": {}
  }
}

401

Section titled “401”

No authentication key was sent.

Media typeapplication/json

Authentication failures use an error key rather than message.

object
error
required
string
Examples
Examplemissing

No bearer token sent

{
  "error": "JWT passport exception: Missing bearer token in request"
}

419

Section titled “419”

The authentication key is expired or not recognised. Get a fresh one and retry.

Media typeapplication/json

Authentication failures use an error key rather than message.

object
error
required
string
Examples
Exampleexpired
{
  "error": "JWT passport expired: Passport expired"
}