Skip to main content
GET
Chronological, paginated feed of commissions and building works for one establishment.

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

whereUnitIds
string<uuid>[]

Restrict to these units. Omitted, the register spans every unit the caller can read.

Required array length: 1 - 250 elements
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:
types
enum<string>[]

Event kinds to include. Defaults to both. Available: commission, buildingWork

Available options:
commission,
buildingWork
whereOccurredAt
any

Restrict to the commission's heldAt / the building work's startAt date range.

Example:
orderBy
enum<string>
default:desc

Sort direction on the displayed date.

Available options:
asc,
desc

Response

Default Response

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