Skip to main content
GET
List units (parents and children), paginated (BO)

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, canBeDeleted, canBeArchived, canBeUnarchived } per row.
  • "updatable-fields": Per-field write rules per row in its current state.
  • "nb-children": Number of non-deleted children (always 0 on a child unit) and QR codes, per row.
  • "organization": Each unit's organization (id, name, type, accessStatus).
  • "created-by": The BO admin who created each unit.
Available options:
actions-info,
updatable-fields,
nb-children,
organization,
created-by
orderBy
object[]
whereOrganizationId
string<uuid>

Filter by the unit's organization 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)$
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"

whereClassifications
string[]

Filter by classification (matches any of the given codes).

Example:
whereCategory
string[]

Filter by ERP category (matches any of the given codes).

Example:
whereOnboardingStatus
string[]

Filter by onboarding status (matches any of the given codes).

Example:
whereArchived

When true, only archived; when false, only non-archived.

Example:

true

whereIncludeDeleted

When true, also returns soft-deleted units.

Example:

true

whereAddressStreet
string

Case-insensitive partial match on the (parent) address street.

Maximum string length: 200
Example:

"lobby"

whereAddressCity
string

Case-insensitive partial match on the (parent) address city.

Maximum string length: 200
Example:

"lobby"

whereAddressPostalCode
string

Case-insensitive partial match on the (parent) postal code.

Maximum string length: 200
Example:

"lobby"

whereAddressCountry
string

Case-insensitive partial match on the (parent) address country.

Maximum string length: 200
Example:

"lobby"

whereTotalSurfaceArea
integer

Exact match on total surface area.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

42

wherePublicCapacity
integer

Exact match on public capacity.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

42

wherePrivateCapacity
integer

Exact match on private capacity.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

42

wherePinCodeEnabled

Filter by the pinCodeRequired flag.

Example:

true

whereCreatedAt
object

Filter by creation date range.

Example:
whereCreatedById
string<uuid>

Filter by the id of the BO admin who created the unit.

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)$
whereChildCount
object

Filter by number of non-deleted children, with comparator (op: =, !=, >, >=, <, <=).

Example:

Response

Default Response

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