Skip to main content
GET
List the organization documents (paginated)

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"]):

  • "folder": Include the containing folder (id, name), null when unclassified.
  • "label": Include the linked label (id, name, color) when present.
  • "created-by": Adds the document author (createdByUser with display name).
  • "actions-info": Adds actions { canBeUpdated, canBeReplaced, canBeArchived, canBeUnarchived, canBeDeleted }.
  • "versions-count": Adds versionsCount, the number of past replacement versions.
  • "source": Include the carrier entity (report, contract, plan, building work) the document comes from, null for a plain upload.
Available options:
folder,
label,
created-by,
actions-info,
versions-count,
source
orderBy
object[]

Case-insensitive search across name and ref.

Maximum string length: 200
Example:

"lobby"

whereType
string[]

Filter by one or more document types.

Example:
whereOrigin
string[]

Filter by one or more document origins.

Example:
whereFolderId

Filter by folder id; the sentinel "none" means unclassified documents (no folder).

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)$
whereUnitId
string<uuid> · enum<string> · enum<string>[]

Filter by one or more unit ids; the sentinel "none" matches documents linked to no unit, and "any" those linked to one.

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)$
whereTechnicalInstallationId
string<uuid> · enum<string> · enum<string>[]

Filter by one or more technical installation ids; the sentinel "none" matches documents linked to no technical installation, and "any" those linked to one.

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)$
whereBuildingWorkId
string<uuid> · enum<string> · enum<string>[]

Filter by one or more building-work ids; the sentinel "none" matches documents linked to no building-work, and "any" those linked to one.

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> | enum<string>)[]

Filter by one or more label ids; the sentinel "none" matches documents with no label.

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)$
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 documents; when false, only non-archived.

Example:

true

whereCreatedAt
object

Filter by the creation-date range.

Example:

Response

Default Response

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