Skip to main content
GET
List QR codes (BO, 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"]):

  • "linked-element": Adds linkedElement per row (the unit/equipment/building/plan/plan-item it points to).
  • "actions-info": Adds actions { canBeUpdated } per row.
  • "updatable-fields": Adds updatableFields per row.
Available options:
linked-element,
actions-info,
updatable-fields
orderBy
object[]
whereIsAssociated

Filter by association status (true = linked to a unit/equipment/building/plan/plan-item).

Example:

true

whereOrganizationId
string<uuid>

Filter by 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)$
whereSlug
string

Filter by slug (exact match).

Maximum string length: 200
Example:

"lobby"

whereGenerationId
string<uuid>

Filter by generation 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)$
whereNumberFrom
integer

Filter by serial number lower bound (inclusive).

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

42

whereNumberTo
integer

Filter by serial number upper bound (inclusive).

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

42

whereIsActive

Filter by active status (activatedAt set or not).

Example:

true

whereText
string

Free-text search across slug, organization name and linked unit name.

Maximum string length: 200
Example:

"lobby"

Response

Default Response

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