Skip to main content
GET
List building works (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"]):

  • "units": Adds units (the active units each building work targets).
  • "commission": Adds commission (the most recently held safety commission, or null).
  • "created-by": Adds the building work author (createdByUser with display name).
  • "documents-stats": Adds documentsStats (count of active documents attached to the work, and the distinct document types present).
  • "actions-info": Projects { canBeUpdated, canBeArchived, canBeUnarchived, canBeDeleted }.
  • "updatable-fields": Per-field write rules for each building work in its current state.
Available options:
units,
commission,
created-by,
documents-stats,
actions-info,
updatable-fields
orderBy
object[]
whereIds
string<uuid>[]

Filter by one or more building work 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:

Case-insensitive search across ref, authorization number, work nature, contractor name, supervising technician name and architect name.

Maximum string length: 200
Example:

"lobby"

whereStatus
string[]

Filter by one or more building work statuses.

Example:
whereUnitIds
string<uuid>[]

Filter by one or more unit ids the building work targets.

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:
whereCreatedById
string<uuid>[]

Filter by one or more author user 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:
whereArchived

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

Example:

true

whereStartAt
object

Filter by the work start date range.

Example:
whereEndAt
object

Filter by the work end date range.

Example:
whereReceivedAt
object

Filter by the reception date range.

Example:
whereCreatedAt
object

Filter by creation date range.

Example:
whereIncludeDeleted

When true, also returns soft-deleted building works.

Example:

true

Response

Default Response

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