List Gates

List Goki Gates

GET [environmentBaseUrl]/v1/gates

List all Goki Gates

Query Parameters

NameTypeDescription

filter

object

Gates Filter (please read blow).

page

object

Page limit and offset (please read blow)

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

Gates Filter

Property

Type

Required

Description

type

string

N

Type of the retrieved gates. Available types are "room" and "commonArea".

floor

string

N

Filter of the retrieved gates.

Page limit and offset

Property

Type

Required

Description

limit

number

N

Size of retrieved data on each page.

offset

number

N

The page number.

Last updated