Skip to content
Optiwork API Docs

Get a world

GET
/spaces/maps/{map}
curl --request GET \
  --url https://spaces.work.optidata.cloud/api/spaces/maps/a28e5bf3-26b4-4a34-9f98-9a116a2700ca \
  --header 'Authorization: Bearer <token>'

A world with its map document and group areas. Everyone in the company can read the active world; drafts are for builders only.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
map
required
string

The world’s identifier.

Responses

Section titled “ Responses ”

200

Section titled “200”

The world.

Media typeapplication/json
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
Example
{
  "status": "draft",
  "data": {
    "type": "map"
  }
}

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"
}

403

Section titled “403”

The caller is not allowed to do this (see “Who may do what”), or the authentication key is not recognised (empty message).

Media typeapplication/json
object
message
required
string
Examples

Not the space's owner

{
  "message": "You do not have permission to update this space."
}

404

Section titled “404”

Nothing has this identifier.

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}

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"
}