Skip to main content
GET
List the logbook register (unit/label/date filters)

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": Includes the linked units (id, ref, name).
  • "label": Includes the linked label (id, name, color) when present.
  • "createdBy": Includes the creator's identity when it is still linked.
  • "signatures": Include the signature history per row, newest first: one at creation, one per modification.
  • "actions-info": Adds actions { canBeUpdated, canBeEnabled, canBeDisabled } per row.
  • "updatable-fields": Adds updatableFields (per-field editability) per row.
Available options:
units,
label,
createdBy,
signatures,
actions-info,
updatable-fields
orderBy
object[]

Case-insensitive partial match on the reference, the title or the description.

Maximum string length: 200
Example:

"lobby"

whereUnitIds
string<uuid>[]

Narrow linked logbook entries 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:
whereEnabled

When true, only active entries; when false, only inactive ones.

Example:

true

whereLabelId
string<uuid>

Filter by a single label id. Prefer whereLabelIds, which accepts several.

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)$
whereLabelIds
string<uuid>[]

Filter by one or more label 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:
whereCreatedBy
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:
whereCreatedAt
object

Filter by creation date range.

Example:
whereOccurredAt
object

Filter by the occurred-at date range.

Example:
whereArchived

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

Example:

true

Response

Default Response

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