Skip to main content
GET
List library rules (BO)

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-installations": Include the linked library technical installations (id, nameFr/nameEn/nameDe) - preventive only.
  • "created-by": Adds createdByBoUser { id, name, email } (the BO admin who created it).
  • "counts": Adds _count.instances (active organization instances adopted from this rule).
  • "actions-info": Projects { canBeUpdated, canBeArchived, canBeUnarchived, canBeDeleted }.
Available options:
technical-installations,
created-by,
counts,
actions-info
orderBy
object[]

Case-insensitive partial match on the library rule name.

Maximum string length: 200
Example:

"lobby"

whereType
string[]

Filter by one or more rule types.

Example:
whereWorkflowType
string[]

Filter by one or more workflow types (calendar, regulatory).

Example:
whereComplianceType
string[]

Filter by one or more compliance types (registry, maintenance).

Example:
whereArchived

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

Example:

true

whereProviderType
string[]

Filter by library rules concerning any of the given provider types.

Example:
whereTechnicalInstallationIds
string<uuid>[]

Narrow to library rules linked to any of the given library 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:
whereCreatedAt
object

Filter by creation date range.

Example:
whereUpdatedAt
object

Filter by last-update date range.

Example:
whereIncludeDeleted

When true, also returns soft-deleted library rules.

Example:

true

Response

Default Response

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