List Spaces

List Goki Rooms/Beds

GET [environmentBaseUrl]/v1/spaces

List all Goki spaces (rooms/beds).

Query Parameters

Name
Type
Description

filter

object

Spaces Filter (please read below).

page

object

Page limit and offset (please read below).

{
  "data": {
    "list": [
      {
        ...SpaceDocument // Check SpaceDocument page for the sample data
      }
    ],
    "total": 120
  }
}

Spaces Filter

Property

Type

Required

Description

type

string

N

Type of the retrieved spaces. Available types are "room" and "bed".

floor

string

N

Floor of the retrieved spaces.

parentSpaceId

string

N

To list the beds of a room, set the room ID to this filter.

Page limit and offset

Property

Type

Required

Description

limit

number

N

Size of retrieved data on each page.

offset

number

N

The page number.

Example

GET    [environmentBaseUrl]/v1/spaces?filter[type]=room&page[offset]=0&page[limit]=10    

Last updated