Skip to main content
GET
List equipments (paginated/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"]):

  • "technical-installation": Adds technicalInstallation (each equipment's technical installation).
  • "unit": Adds unit (the unit each equipment is attached to, nullable).
  • "installed-by": Adds installedBy (the installer provider, nullable).
  • "position": Adds position (the marker on a plan, nullable).
  • "contained-in": Adds containedIn (the zones/rooms each equipment sits in).
  • "specifications": Adds specifications (the specification values tagging each equipment).
  • "qrcode": Adds qrcode (the QR code associated to each equipment, nullable).
  • "qrcodes": Adds qrcodes (every QR code associated to each equipment, by serial number).
  • "counts": Adds counts (anomalies by processing state, tickets, compliances by status, QR codes, responsibilities and interventions attached to each equipment).
  • "actions-info": Projects { canBeUpdated, canBeArchived, canBeUnarchived, canBeDeleted }.
  • "updatable-fields": Per-field write rules for each equipment in its current state.
  • "responsibles": Adds responsibles - the users responsible for this element.
  • "created-by": Adds createdBy (the user who created each equipment).
Available options:
technical-installation,
unit,
installed-by,
position,
contained-in,
specifications,
qrcode,
qrcodes,
counts,
actions-info,
updatable-fields,
responsibles,
created-by
orderBy
object[]

Case-insensitive search across name and ref.

Maximum string length: 200
Example:

"lobby"

whereName
string

Case-insensitive partial match on the name.

Maximum string length: 200
Example:

"lobby"

whereArchived

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

Example:

true

whereUnitIds
string<uuid>[]

Narrow linked equipments 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 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:
whereCondition
string[]

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

Example:
whereAvailability
string[]

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

Example:
whereInstalledBy
string<uuid>[]

Filter by installer provider id.

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:
wherePositioned

When true, only equipments with a position marker; when false, without.

Example:

true

whereCanBePositionedInPlan
string<uuid>

Equipments belonging to the plan's unit that have no active plan position yet - feeds the plan's placement picker.

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

Filter by creation date range.

Example:
whereUpdatedAt
object

Filter by last-update date range.

Example:
whereImResponsible

When true, restricts to equipments the current user is responsible for - holding a responsibility on the equipment, on its technical installation or on its unit. Narrows the caller’s visibility scope, never widens it.

Example:

true

whereIncludeDeleted

When true, also returns soft-deleted equipments.

Example:

true

Response

Default Response

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