Skip to main content
GET
List units (parents and children), flat and filterable

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
integer
default:1
Required range: 0 < x <= 9007199254740991
pageSize
integer
default:50
Required range: 0 < x <= 1000
countOnly
boolean

When true, answers totalCount with an empty data: the rows are never read, so no extend is selected and no transform runs. For a badge or a counter.

Example:

true

extend
enum<string>[]

Extend options (JSON-encoded array, e.g. ?extend=["category"]):

  • "actions-info": Projects { canBeUpdated } per row for the current viewer.
  • "updatable-fields": Per-field write rules per row in its current state.
  • "tags": Each unit's tags with their tag type.
  • "position": Structural context under each unit: buildings → plans → plan items.
  • "qrcode": Sticker scan URL for the QR code linked to each unit (null when none).
  • "responsibles": Adds responsibles - the users responsible for this element.
  • "created-by": Adds createdBy (the user who created each unit), null when unknown.
Available options:
actions-info,
updatable-fields,
tags,
position,
qrcode,
responsibles,
created-by
orderBy
object[]
whereUnitIds
string<uuid>[]

Narrow the result to the requested unit ids.

Maximum array length: 250
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:
whereITIds
string<uuid>[]

Narrow the result to units linked to the requested technical installations.

Maximum array length: 250
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:
whereType
string[]

Filter by sub-type (parent, child).

Example:
whereParentId
string<uuid>

Filter child units by their parent unit's id.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
whereName
string

Case-insensitive partial match on the unit name.

Maximum string length: 200
Example:

"lobby"

whereSerialNumber
string

Case-insensitive partial match on the serial number.

Maximum string length: 200
Example:

"lobby"

whereText
string

Free-text search across name and serial number.

Maximum string length: 200
Example:

"lobby"

whereTags
string<uuid>[]

Units carrying at least one of the given tag ids.

Maximum array length: 250
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:
whereImResponsible

When true, restricts to units the current user is responsible for. A responsibility names one unit: it does not cascade to child units. Narrows the caller’s visibility scope, never widens it.

Example:

true

Response

Default Response

data
object[]
required
totalCount
integer
required
Required range: 0 <= x <= 9007199254740991
pagination
object
required