Goki API
Search
⌃K

SpaceDocument

Response Model for Space Document
This is the representation of the SpaceDocument data structure you receive in the Space API response.
These are Goki spaces (rooms/beds), meaning the name and IDs are not what you submitted to Goki.
A space of type room.
{
"id": "369f0fc9-185a-486b-a12e-3979a850191e",
"name": "Room 1",
"hostelId": "9384urfdk-185a-486b-a12e-39737y4rf",
"type": "room",
"floor": "2",
"createdAt": "2020-08-23T21:11:34+00:00",
"updatedAt": "2020-09-30T23:10:14+00:00"
}
A space of type bed related to the room above.
{
"id": "3f0b8b48-21ce-4ccc-96dd-5cb2749fe4d4",
"name": "Bed 1-1",
"hostelId": "9384urfdk-185a-486b-a12e-39737y4rf",
"type": "bed",
"floor": "2",
"parentSpaceId": "369f0fc9-185a-486b-a12e-3979a850191e",
"createdAt": "2020-08-23T21:11:34+00:00",
"updatedAt": "2020-09-30T23:10:14+00:00"
}
Property
Type
Required
Description
id
string
Y
ID of the space in Goki
name
string
Y
Space name in Goki
hostelId
string
Y
ID of the property in Goki
type
string
Y
Type of the Goki space. Can be one of room or bed
floor
string
N
Floor name of the space
parentSpaceId
string
N
The id of the parent room, if the space type is bed
createdAt
string
Y
Space creation date
updatedAt
string
Y
Space modification date